Agent skill

read-github

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

View SKILL.md on GitHub Repository
Stars 846
Forks 44

Install this agent skill to your Project

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

SKILL.md

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

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

am-will/codex-skills

markdown-url

Route any website you need to visit through markdown.new by prefixing the URL. **WHEN TO USE:** - You would normally open a website link to read content (docs, blog posts, changelogs, GitHub issues, etc.) - You need a cleaner, Markdown-friendly view for copying notes or summarizing

846 44
Explore
am-will/codex-skills

Frontend Responsive Design Standards

Build responsive, mobile-first layouts using fluid containers, flexible units, media queries, and touch-friendly design that works across all screen sizes. Use this skill when creating or modifying UI layouts, responsive grids, breakpoint styles, mobile navigation, or any interface that needs to adapt to different screen sizes. Apply when working with responsive CSS, media queries, viewport settings, flexbox/grid layouts, mobile-first styling, breakpoint definitions (mobile, tablet, desktop), touch target sizing, relative units (rem, em, %), image optimization for different screens, or testing layouts across multiple devices. Use for any task involving multi-device support, responsive design patterns, or adaptive layouts.

846 44
Explore
am-will/codex-skills

super-swarm-spark

Only to be triggered by explicit super-swarm-spark commands.

846 44
Explore
am-will/codex-skills

pluginstaller

Add a Codex plugin from a GitHub repo to a repo or personal marketplace using the current Codex plugin layout and marketplace metadata.

846 44
Explore
am-will/codex-skills

vercel-react-best-practices

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.

846 44
Explore
am-will/codex-skills

plan-harder

Use when user specfically says 'plan harder'.

846 44
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results