read-github：GitHub仓库文档与代码读取工具，支持语义搜索和URL转换

read-github by am-will/codex-skills

1,200 周安装量

810 GitHub Stars

GitHub

安装命令

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

AI/机器学习开发生产力

🇨🇳中文介绍

读取 GitHub 文档

通过 gitmcp.io MCP 服务访问 GitHub 仓库文档和代码。

URL 转换

将 GitHub URL 转换为 gitmcp.io：

github.com/owner/repo → gitmcp.io/owner/repo
https://github.com/karpathy/llm-council → https://gitmcp.io/karpathy/llm-council

CLI 使用

scripts/gitmcp.py 脚本提供了对仓库文档的 CLI 访问。

列出可用工具

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

获取文档

检索完整的文档文件（README、docs 等）：

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

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

相关 Skills

find-skills 技能搜索工具 - Vercel Labs 开源智能体技能包管理器

685,800 周安装

Vercel React 最佳实践指南 | 58条Next.js性能优化规则与代码重构

240,900 周安装

Vercel Web界面规范检查工具 - 自动检测代码是否符合Web设计指南

193,000 周安装

agent-browser 浏览器自动化工具 - Vercel Labs 命令行网页操作与测试

125,000 周安装

React 组合模式指南：Vercel 组件架构最佳实践，提升代码可维护性

在仓库文档中进行语义搜索：

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

使用 GitHub 搜索 API（精确匹配）搜索代码：

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

从文档中提到的 URL 获取内容：

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

直接调用任何 MCP 工具：

python3 scripts/gitmcp.py call owner/repo tool_name '{"arg": "value"}'

工具名称会动态地加上仓库名前缀（使用下划线连接）：

karpathy/llm-council → fetch_llm_council_documentation
facebook/react → fetch_react_documentation
my-org/my-repo → fetch_my_repo_documentation

可用的 MCP 工具

对于任何仓库，以下工具可用：

fetch_{repo}_documentation - 获取完整文档。对于一般性问题，请首先调用此工具。
search_{repo}_documentation - 在文档中进行语义搜索。用于特定查询。
search_{repo}_code - 通过 GitHub API（精确匹配）搜索代码。返回匹配的文件。
fetch_generic_url_content - 获取文档中引用的任何 URL，遵守 robots.txt。

当给定一个 GitHub 仓库时，首先获取文档以了解项目
使用 search-docs 来询问有关用法或功能的特定问题
使用 search-code 来查找实现或特定函数
使用 fetch-url 来检索文档中提到的外部引用

2026 年 1 月 23 日

🇺🇸English

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:

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

Weekly Installs

11.8K

Repository

am-will/codex-skills

GitHub Stars

488

First Seen

Jan 23, 2026

Security Audits

Gen Agent Trust HubFail SocketPass SnykWarn

Installed on

codex11.8K

gemini-cli11.7K

opencode11.7K

github-copilot11.7K

cursor11.7K

amp11.7K