阅读GitHub文档

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

URL转换

将GitHub URL转换为gitmcp.io格式：

• github.com/所有者/仓库→gitmcp.io/所有者/仓库
• https://github.com/karpathy/llm-council→https://gitmcp.io/karpathy/llm-council

命令行界面使用

脚本scripts/gitmcp.py提供对仓库文档的命令行界面访问。

列出可用工具

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

获取文档

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

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获取文档中提到的外部引用