read-github
Read and search GitHub repository documentation via gitmcp.io MCP service. **WHEN TO USE:** - User provides a GitHub URL - User mentions a specific repo in owner/repo format - User asks "what does this repo do?", "read the docs for X repo", or similar - User wants to search code or docs within a repo
How do I install this agent skill?
npx skills add https://github.com/am-will/codex-skills --skill read-githubIs this agent skill safe to install?
- Gen Agent Trust Hubfail
The skill enables the agent to read arbitrary content from GitHub via a third-party proxy and provides a tool-calling interface. This creates a significant Indirect Prompt Injection vulnerability where malicious repo documentation could control the agent.
- Socketpass
No alerts
- Snykwarn
Risk: MEDIUM · No issues
- Runlayerwarn
1/2 files flagged
- ZeroLeakspass
Score: 93/100 · 2 sections analyzed
What does this agent skill do?
Read GitHub Docs
Access GitHub repository documentation and code via the gitmcp.io MCP service.
URL Conversion
Convert GitHub URLs to gitmcp.io:
github.com/owner/repo→gitmcp.io/owner/repohttps://github.com/karpathy/llm-council→https://gitmcp.io/karpathy/llm-council
CLI Usage
The scripts/gitmcp.py script provides CLI access to repository docs.
List Available Tools
python3 scripts/gitmcp.py list-tools owner/repo
Fetch Documentation
Retrieves the full documentation file (README, docs, etc.):
python3 scripts/gitmcp.py fetch-docs owner/repo
Search Documentation
Semantic search within repository documentation:
python3 scripts/gitmcp.py search-docs owner/repo "query"
Search Code
Search code using GitHub Search API (exact match):
python3 scripts/gitmcp.py search-code owner/repo "function_name"
Fetch Referenced URL
Fetch content from URLs mentioned in documentation:
python3 scripts/gitmcp.py fetch-url owner/repo "https://example.com/doc"
Direct Tool Call
Call any MCP tool directly:
python3 scripts/gitmcp.py call owner/repo tool_name '{"arg": "value"}'
Tool Names
Tool names are dynamically prefixed with the repo name (underscored):
karpathy/llm-council→fetch_llm_council_documentationfacebook/react→fetch_react_documentationmy-org/my-repo→fetch_my_repo_documentation
Available MCP Tools
For any repository, these tools are available:
- fetch_{repo}_documentation - Fetch entire documentation. Call first for general questions.
- search_{repo}_documentation - Semantic search within docs. Use for specific queries.
- search_{repo}_code - Search code via GitHub API (exact match). Returns matching files.
- fetch_generic_url_content - Fetch any URL referenced in docs, respecting robots.txt.
Workflow
- When given a GitHub repo, first fetch documentation to understand the project
- Use search-docs for specific questions about usage or features
- Use search-code to find implementations or specific functions
- Use fetch-url to retrieve external references mentioned in docs
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/am-will/codex-skills/read-github">View read-github on skillZs</a>