0xharryriddle/read-github
archive/upstream/examples/skills/read-github/SKILL.md
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
$ install --global
skillsauthnpx skillsauth add 0xharryriddle/codex-field-kit read-githubInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Error
VirusTotalMulti-engine malware detection
70%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Mar 24, 2026, 9:58 AM42.2s2 files scanned
SKILL.md
- name:
- read-github
- description:
- |
- **WHEN TO USE:
- **
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
Related Skills
0xharryriddle/vercel-react-best-practices
development
VerifiedTrustedCommunity
React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.
2SKILL.mdUpdated Mar 24, 2026
0xharryriddle/swarm-planner
testing
VerifiedTrustedCommunity
[EXPLICIT INVOCATION ONLY] Creates dependency-aware implementation plans optimized for parallel multi-agent execution.
2SKILL.mdUpdated Mar 24, 2026
0xharryriddle/super-swarm-spark
testing
VerifiedTrustedCommunity
Only to be triggered by explicit super-swarm-spark commands.
2SKILL.mdUpdated Mar 24, 2026
0xharryriddle/role-creator
development
VerifiedTrustedCommunity
Create and install Codex custom agent roles in ~/.codex/config.toml, generate role config files, enforce supported keys, and guide users through required role inputs (model, reasoning effort, developer_instructions).
2SKILL.mdUpdated Mar 24, 2026