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
- Installs
- 1.2K
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/am-will/codex-skills --skill read-github- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads read-github automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
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/repohttps://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_documentationfacebook/react→fetch_react_documentationmy-org/my-repo→fetch_my_repo_documentation
Available MCP Tools
For any repository, these tools are available:
- fetch_{repo}_documentation - Fetch entire documentation. Call first for general questions.
- search_{repo}_documentation - Semantic search within docs. Use for specific queries.
- search_{repo}_code - Search code via GitHub API (exact match). Returns matching files.
- fetch_generic_url_content - Fetch any URL referenced in docs, respecting robots.txt.
Workflow
- When given a GitHub repo, first fetch documentation to understand the project
- Use search-docs for specific questions about usage or features
- Use search-code to find implementations or specific functions
- Use fetch-url to retrieve external references mentioned in docs
FAQ
What does the read-github skill do?
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
How do I install read-github?
Run npx skills add https://github.com/am-will/codex-skills --skill read-github in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/read-github/ (personal) or .claude/skills/read-github/ (project).
Which AI agents can use read-github?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is read-github safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains read-github?
It is published by am-will in am-will/codex-skills. It has 1,193 recorded installs.
More from am-will/codex-skills
frontend-design
am-will/codex-skills
Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.
frontend responsive design standards
am-will/codex-skills
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.
context7
am-will/codex-skills
Fetch up-to-date library documentation via Context7 CLI. Use PROACTIVELY when: (1) Working with ANY external library (React, Next.js, Supabase, etc.) (2) User asks about library APIs, patterns, or best practices (3) Implementing features that rely on third-party packages (4) Debugging library-specific issues (5) Need current documentation beyond training data cutoff (6) AND MOST IMPORTANTLY, when you are installing dependencies, libraries, or frameworks you should ALWAYS check the docs to see what the latest versions are. Do not rely on outdated knowledge. Always prefer this over guessing library APIs or using outdated knowledge.
planner
am-will/codex-skills
Create comprehensive, phased implementation plans with sprints and atomic tasks. Use when user says: "make a plan", "create a plan", "plan this out", "plan the implementation", "help me plan", "design a plan", "draft a plan", "write a plan", "outline the steps", "break this down into tasks", "what's the plan for", or any similar planning request. Also triggers on explicit "/planner" or "/plan" commands.
parallel-task
am-will/codex-skills
Only to be triggered by explicit /parallel-task commands.
plan-harder
am-will/codex-skills
Use when user specfically says 'plan harder'.
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown：查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件，或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.