read-github — Claude Code skill: read GitHub docs via gitmcp.io
Lets the agent pull documentation and code from any GitHub repository through the gitmcp.io MCP service. Useful when you need to understand a project without cloning it.
npx skills add am-will/codex-skills --skill read-github -a claude-codeWhat read-github does
The skill turns a repository link into a source of answers. Hand the agent a URL like github.com/owner/repo or just owner/repo, and it fetches the README and other documentation files through gitmcp.io. A script at scripts/gitmcp.py does the work, with subcommands list-tools, fetch-docs, search-docs, search-code, fetch-url, and call for hitting an MCP tool directly.
Doc search is semantic; code search goes through the GitHub Search API and matches exactly. Tool names get prefixed with the repo name on the fly: facebook/react becomes fetch_react_documentation, my-org/my-repo becomes fetch_my_repo_documentation. Dashes turn into underscores.
The script runs under python3, so Python has to be on your machine. External links mentioned in the docs are fetched separately and robots.txt is respected — a site that blocks crawlers returns nothing. Worth remembering when an answer about a linked page comes back empty.
What it helps with
- read a repo's README without cloning it
- find a specific function in a codebase by name
- answer a question about a library from its own docs
- pull content from an external link cited in the documentation
- check which MCP tools a repository exposes
Example prompts for the agent
- Read the docs for facebook/react and explain how rendering works
- Search the karpathy/llm-council code for the request handler
- What does owner/repo do? Look at its documentation
How to install read-github
1Skills CLI (Vercel)
npx skills add am-will/codex-skills --skill read-github -a claude-code2Manually: put the files in place
~/.claude/skills/read-github/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/read-github/
1Skills CLI (Vercel)
npx skills add am-will/codex-skills --skill read-github -a codex2Manually: put the files in place
.agents/skills/read-github/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add am-will/codex-skills --skill read-github -a cursor2Manually: put the files in place
.cursor/skills/read-github/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install am-will/codex-skills read-github2Manually: put the files in place
.github/skills/read-github/SKILL.md1Skills CLI (Vercel)
npx skills add am-will/codex-skills --skill read-github -a gemini-cli2Platform CLI
gemini skills install https://github.com/am-will/codex-skills --path skills/read-githubManually: put the files in place
.devin/skills/read-github/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add am-will/codex-skills --skill read-github -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about read-github
How do I install read-github in Claude?
Run npx skills add am-will/codex-skills --skill read-github -a claude-code. The skill file lands at ~/.claude/skills/read-github/SKILL.md.
What does read-github do?
It reads and searches GitHub repository documentation and code through the gitmcp.io MCP service. Works from a URL or an owner/repo string.
What does the skill need to run?
The scripts/gitmcp.py script runs under python3, so Python must be installed. External links are fetched with robots.txt in mind.