mcpField
R
read-github

read-github

github.com/am-willDevelopment1.0k1.2k installsUpdated 15w ago
Repository

About read-github

read-github is a skill for accessing GitHub repository documentation and code through the gitmcp.io MCP service. Its CLI supports documentation retrieval and search, code search, URL fetching, and direct tool calls.

Key features

  1. 01List repository-specific tools
  2. 02Fetch repository documentation
  3. 03Search docs semantically
  4. 04Search code with GitHub Search API
  5. 05Fetch URLs referenced in docs
  6. 06Call MCP tools directly

Use cases

  1. 01Retrieve a repository's README and docs
  2. 02Find guidance for a specific query
  3. 03Locate exact code matches
  4. 04Call a repository documentation tool

MCP support

The skill uses the gitmcp.io MCP service, exposing repository documentation, search, code search, URL fetching, and direct tool calls through its CLI.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/am-will/codex-skills --skill read-github

After installing, type/read-githubin Claude Code to confirm it loaded.

Bundled filesscripts/gitmcp.py

Details

From the project README

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/repo
  • https://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_documentation
  • facebook/react → fetch_react_documentation
  • my-org/my-repo → fetch_my_repo_documentation

Available MCP Tools

For any repository, these tools are available:

  1. fetch_{repo}_documentation - Fetch entire documentation. Call first for general questions.
  2. search_{repo}_documentation - Semantic search within docs. Use for specific queries.
  3. search_{repo}_code - Search code via GitHub API (exact match). Returns matching files.
  4. fetch_generic_url_content - Fetch any URL referenced in docs, respecting robots.txt.

Workflow

  1. When given a GitHub repo, first fetch documentation to understand the project
  2. Use search-docs for specific questions about usage or features
  3. Use search-code to find implementations or specific functions
  4. Use fetch-url to retrieve external references mentioned in docs

Comments

Markdown supported