阅读 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 脚本提供对仓库文档的命令行访问能力。

列出可用工具

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

获取文档

获取完整文档文件（如 README、docs 等）：

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

文档语义搜索

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

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

代码搜索

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

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

获取引用的 URL 内容

获取文档中提及的任意 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 工具

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

1. fetch_{repo}_documentation — 获取全部文档。通用问题请优先调用此工具。
2. search_{repo}_documentation — 在文档内进行语义搜索。适用于具体问题查询。
3. search_{repo}_code — 通过 GitHub API 搜索代码（精确匹配），返回匹配的文件列表。
4. fetch_generic_url_content — 获取文档中引用的任意 URL 内容，并遵守 robots.txt 协议。

工作流程

1. 收到 GitHub 仓库地址后，首先调用 fetch-docs 获取文档，以理解项目整体结构
2. 针对具体使用方式或功能细节等问题，使用 search-docs
3. 查找具体实现逻辑或函数定义时，使用 search-code
4. 当文档中提及外部链接（如设计文档、API 参考等）时，使用 fetch-url 获取其内容