skilld
All skills
am-will avatar

/read-github

@5d828ef
by am.willam-will/codex-skills1k stars
60

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

Ask your Agent

Use this Skill: https://skilld.dev/gh/am-will/codex-skills/read-github

This session only. Nothing lands on disk.

SKILL.md

≈79 tokens always: the name and description. ≈551 when used: this file.

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

Source: SKILL.md on GitHub

Third-party checks

4 warnings11d5 checks · Risk MEDIUM
  • Gen Agent Trust Hub11d

    This skill accesses GitHub repositories via an external service called gitmcp.io. It downloads and executes a package from the NPM registry at runtime to establish this connection. Furthermore, it is vulnerable to indirect prompt injection, as it processes untrusted documentation and code directly from GitHub repositories without sanitization.

  • Socket11d

    2 alerts: gptAnomaly

  • Snyk11d

    Risk: MEDIUM · 2 issues

  • Runlayer7mo

    1/2 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at 5d828ef. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 months ago.

Steadyupdated 8 months ago

Topics

README badge

README badge for am-will/codex-skills/read-github

What it does

Fetches and searches GitHub repository documentation and code through the gitmcp.io MCP service. Includes CLI tools to fetch full docs, search documentation semantically, search code by exact match, and retrieve external URLs referenced in repositories.

Generated from the current SKILL.md.

Frequently asked

What does this skill do?
It reads and searches GitHub repository documentation and code via the gitmcp.io MCP service. You provide a GitHub URL or owner/repo, and the skill fetches docs, performs semantic search within documentation, searches code via GitHub API, and retrieves URLs referenced in docs.
Do I need to authenticate with GitHub?
The skill uses the gitmcp.io MCP service, which handles GitHub API access. No explicit authentication setup is described in the SKILL.md.
Can this search code within a repo?
Yes. The skill provides exact-match code search via GitHub's Search API using the search-code command. It can find specific functions or code patterns but does not perform fuzzy or semantic code search.
What's the difference between search-docs and search-code?
search-docs performs semantic search within repository documentation (README, docs files, etc.), while search-code performs exact-match searching on the actual source code using GitHub's Search API.

Generated from the current SKILL.md. These answers refresh after source changes.