⚡

GitHub文档读取器 read-github

GitHub文档读取器是一个通过gitmcp.io MCP服务访问和搜索GitHub仓库文档与代码的工具。它支持将GitHub URL转换为gitmcp.io格式，并提供命令行接口（CLI）进行文档获取、语义搜索、代码搜索、引用URL内容获取等操作。该工具能自动为不同仓库生成对应的工具名称（如fetch_仓库名_documentation），适用于开发者、技术文档工程师、开源项目维护者等需要快速理解、查阅或分析GitHub项目代码与文档的场景。关键词：GitHub文档读取，代码搜索，语义搜索，MCP服务，gitmcp.io，命令行工具，开源项目分析。

DevOps 0 次安装 0 次浏览 更新于 3/5/2026

名称: 读取GitHub 描述: | 通过gitmcp.io MCP服务读取和搜索GitHub仓库文档。

使用时机:

  • 用户提供GitHub URL
  • 用户提及特定仓库（格式为 所有者/仓库名）
  • 用户询问“这个仓库是做什么的？”、“读取X仓库的文档”或类似问题
  • 用户想要在仓库内搜索代码或文档

读取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 所有者/仓库

获取文档

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

python3 scripts/gitmcp.py fetch-docs 所有者/仓库

搜索文档

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

python3 scripts/gitmcp.py search-docs 所有者/仓库 "查询词"

搜索代码

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

python3 scripts/gitmcp.py search-code 所有者/仓库 "函数名"

获取引用的URL

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

python3 scripts/gitmcp.py fetch-url 所有者/仓库 "https://example.com/doc"

直接调用工具

直接调用任何MCP工具：

python3 scripts/gitmcp.py call 所有者/仓库 工具名 '{"参数": "值"}'

工具名称

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

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

可用的MCP工具

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

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

工作流程

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