Read Github

1---2name: read-github3description: |4  Read and search GitHub repository documentation via gitmcp.io MCP service.5 6  **WHEN TO USE:**7  - User provides a GitHub URL8  - User mentions a specific repo in owner/repo format9  - User asks "what does this repo do?", "read the docs for X repo", or similar10  - User wants to search code or docs within a repo11---12 13# Read GitHub Docs14 15Access GitHub repository documentation and code via the gitmcp.io MCP service.16 17## URL Conversion18 19Convert GitHub URLs to gitmcp.io:20- `github.com/owner/repo` → `gitmcp.io/owner/repo`21- `https://github.com/karpathy/llm-council` → `https://gitmcp.io/karpathy/llm-council`22 23## CLI Usage24 25The `scripts/gitmcp.py` script provides CLI access to repository docs.26 27### List Available Tools28 29```bash30python3 scripts/gitmcp.py list-tools owner/repo31```32 33### Fetch Documentation34 35Retrieves the full documentation file (README, docs, etc.):36 37```bash38python3 scripts/gitmcp.py fetch-docs owner/repo39```40 41### Search Documentation42 43Semantic search within repository documentation:44 45```bash46python3 scripts/gitmcp.py search-docs owner/repo "query"47```48 49### Search Code50 51Search code using GitHub Search API (exact match):52 53```bash54python3 scripts/gitmcp.py search-code owner/repo "function_name"55```56 57### Fetch Referenced URL58 59Fetch content from URLs mentioned in documentation:60 61```bash62python3 scripts/gitmcp.py fetch-url owner/repo "https://example.com/doc"63```64 65### Direct Tool Call66 67Call any MCP tool directly:68 69```bash70python3 scripts/gitmcp.py call owner/repo tool_name '{"arg": "value"}'71```72 73## Tool Names74 75Tool names are dynamically prefixed with the repo name (underscored):76- `karpathy/llm-council` → `fetch_llm_council_documentation`77- `facebook/react` → `fetch_react_documentation`78- `my-org/my-repo` → `fetch_my_repo_documentation`79 80## Available MCP Tools81 82For any repository, these tools are available:83 841. **fetch_{repo}_documentation** - Fetch entire documentation. Call first for general questions.852. **search_{repo}_documentation** - Semantic search within docs. Use for specific queries.863. **search_{repo}_code** - Search code via GitHub API (exact match). Returns matching files.874. **fetch_generic_url_content** - Fetch any URL referenced in docs, respecting robots.txt.88 89## Workflow90 911. When given a GitHub repo, first fetch documentation to understand the project922. Use search-docs for specific questions about usage or features933. Use search-code to find implementations or specific functions944. Use fetch-url to retrieve external references mentioned in docs