Repository navigation
docs: correct MCP distribution facts and fit the plugin to the directory rules #7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
01ca59c
2962efb
2e81bf9
f598093
c9d19ab
5769b24
d073451
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ | |
| GitHub SEO Skill is an Agent Skill for Claude Code that gets open-source GitHub repos found on | ||
| Google and GitHub search. It audits a repo's name, description, topics and README, writes a | ||
| search-ready README, runs a pre-publish secret and client-data check, and walks MCP servers | ||
| through registry submissions such as the Official MCP Registry, Smithery, Glama and mcp.so. | ||
| through registry submissions such as the Official MCP Registry, Glama and mcp.so. | ||
|
|
||
| It works with any tool that supports the [Agent Skills](https://agentskills.io) format. | ||
|
|
||
|
|
@@ -44,27 +44,25 @@ Then ask in plain words, for example "audit github.com/you/your-repo for search | |
| | Stage | What you get | | ||
| |---|---| | ||
| | Safety pass | Full-history secret scan and client-data check before anything goes public | | ||
| | Audit | A read-only script scores the description, topics, homepage, license, README shape and community files | | ||
| | Audit | Read-only GitHub CLI checks score the description, topics, homepage, license, README shape and community files | | ||
| | README | An eight-section template aimed at the search snippet, 400 to 700 words | | ||
| | Metadata | Repo slug, About text, topics, Website field and social preview guidance | | ||
| | Launch | A tested order: repo, write-up, community, wider channels, template galleries | | ||
| | MCP servers | A registry-by-registry checklist built around the Official MCP Registry | | ||
|
|
||
| ## Run the audit yourself | ||
|
|
||
| Needs the [GitHub CLI](https://cli.github.com) logged in. The script changes nothing. | ||
| Needs the [GitHub CLI](https://cli.github.com) logged in. The checks change nothing. | ||
|
|
||
| ```bash | ||
| python3 skills/github-seo/scripts/check_repo_seo.py owner/repo | ||
| ``` | ||
|
|
||
| It prints `PASS`, `WARN` or `FAIL` per check and exits non-zero on any `FAIL`. The social preview | ||
| image cannot be read or set through the CLI, so it is listed as a manual step. | ||
| Follow [audit-checks.md](skills/github-seo/references/audit-checks.md): four `gh` commands read the | ||
| repo, and a table gives pass, warn or fail for each check. The social preview image cannot be read | ||
| or set through the CLI, so it is listed as a manual step. | ||
|
|
||
| ## Network access and data | ||
|
|
||
| This repo collects no data and runs no server. The audit script only calls the GitHub CLI (`gh`) | ||
| you have logged in, using read-only requests. When the skill guides an MCP server submission, it | ||
| This repo collects no data and runs no server. The audit only calls the GitHub CLI (`gh`) | ||
| you have logged in, using read-only requests. The listing checks read public pages of the Official | ||
| MCP Registry, npm, Docker Hub and Glama. When the skill guides an MCP server submission, it | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "The listing checks read public pages of the Official MCP Registry, npm, Docker Hub and Glama" — |
||
| tells you to look up a server on the Official MCP Registry | ||
| (`https://registry.modelcontextprotocol.io`), and the publishing steps use the `mcp-publisher` | ||
| tool, which sends your server metadata to that registry. Nothing is sent unless you run those steps. | ||
|
|
@@ -82,9 +80,8 @@ The skill is built to repeat those labels when it reports back, instead of prese | |
| ## Repository layout | ||
|
|
||
| ``` | ||
| skills/github-seo/ # the skill: SKILL.md, references/, scripts/, evals/ | ||
| skills/github-seo/ # the skill: SKILL.md, references/, evals/ | ||
| .claude-plugin/ # plugin and marketplace manifests | ||
| scripts/validate_skill.py # checks frontmatter, evals, manifests and links (runs in CI) | ||
| ``` | ||
|
|
||
| ## Related projects | ||
|
|
||
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Verified the inlined validator: I extracted the heredoc body and ran it against the checkout — prints
ok, exit 0 — and it is behaviorally equivalent to the deletedvalidate_skill.pyon this repo (only the nicerrelative_to(ROOT)error paths are lost). One gap:CONTRIBUTING.mdnow says only "CI checks … on each pull request", so contributors must push to discover a failure. Consider pasting the samepython3 - <<'EOF' …block into CONTRIBUTING as a local pre-push step — YAML/markdown files are allowed by the portal list, so no conflict with the reason this was inlined.