🎯

read-github

🎯Skill

from yuanxiao0115/agent-skills

VibeIndex|
What it does

Retrieves and searches GitHub repository documentation and code via gitmcp.io, enabling easy exploration of project contents and details.

πŸ“¦

Part of

yuanxiao0115/agent-skills(22 items)

read-github

Installation

PythonRun Python server
python3 scripts/gitmcp.py list-tools owner/repo
PythonRun Python server
python3 scripts/gitmcp.py fetch-docs owner/repo
PythonRun Python server
python3 scripts/gitmcp.py search-docs owner/repo "query"
PythonRun Python server
python3 scripts/gitmcp.py search-code owner/repo "function_name"
PythonRun Python server
python3 scripts/gitmcp.py fetch-url owner/repo "https://example.com/doc"

+ 1 more commands

πŸ“– Extracted from docs: yuanxiao0115/agent-skills
7Installs
-
AddedFeb 4, 2026

Skill Details

SKILL.md

Read and search GitHub repository documentation via gitmcp.io MCP service. Use when given a GitHub repo URL or owner/repo path and asked to read docs, understand the codebase, search code, or explore repository contents. Converts github.com URLs to gitmcp.io for LLM-friendly access.

Overview

# 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

```bash

python3 scripts/gitmcp.py list-tools owner/repo

```

Fetch Documentation

Retrieves the full documentation file (README, docs, etc.):

```bash

python3 scripts/gitmcp.py fetch-docs owner/repo

```

Search Documentation

Semantic search within repository documentation:

```bash

python3 scripts/gitmcp.py search-docs owner/repo "query"

```

Search Code

Search code using GitHub Search API (exact match):

```bash

python3 scripts/gitmcp.py search-code owner/repo "function_name"

```

Fetch Referenced URL

Fetch content from URLs mentioned in documentation:

```bash

python3 scripts/gitmcp.py fetch-url owner/repo "https://example.com/doc"

```

Direct Tool Call

Call any MCP tool directly:

```bash

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

More from this repository10

🎯
planner🎯Skill

Generates comprehensive, phased implementation plans with detailed sprints, atomic tasks, and clear requirements clarification across multiple project stages.

🎯
context7🎯Skill

Retrieves up-to-date library documentation via Context7 API, ensuring access to current technical references beyond training data limitations.

🎯
frontend-design🎯Skill

Crafts distinctive, production-grade frontend interfaces with exceptional design quality, avoiding generic AI aesthetics.

🎯
parallel-task🎯Skill

Launches parallel subagents to simultaneously execute tasks from a markdown plan file, triggered by "/parallel-task" command.

🎯
plan-harder🎯Skill

Generates comprehensive, phased implementation plans with atomic tasks, sprints, and detailed requirements analysis for complex development requests.

🎯
agent browser🎯Skill

Enables AI-powered browser automation using a fast Rust-based CLI with Node.js fallback, allowing programmatic web interaction and control.

🎯
vue-best-practices🎯Skill

Enforces Vue 3 TypeScript best practices by providing comprehensive type-safe rules for component props, templates, modules, and performance optimization.

🎯
web-design-guidelines🎯Skill

Provides comprehensive web design guidelines and best practices for creating user-friendly, accessible, and visually appealing websites.

🎯
cli-design-guidelines🎯Skill

Provides comprehensive design guidelines for creating user-friendly, robust, and intuitive command-line interfaces with best practices and human-first UX principles.

🎯
dev-browser🎯Skill

Automates browser tasks by maintaining page state, enabling navigation, form filling, screenshots, and web data extraction across script executions.