Read 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 搜索 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 仓库信息后，首先获取文档以了解项目概况
2. 对于具体使用或功能相关的问题，使用 search-docs
3. 需要查找实现细节或特定函数时，使用 search-code
4. 若文档中提及外部链接，使用 fetch-url 获取相关内容