mcpField
R
read-github

read-github

github.com/am-will开发1.0k1.2k 次安装15 周前更新
代码仓库

关于 read-github

read-github 是一项通过 gitmcp.io MCP 服务访问 GitHub 仓库文档和代码的技能。其命令行工具支持获取和搜索文档、搜索代码、获取 URL 内容及直接调用工具。

主要功能

  1. 01列出仓库专属工具
  2. 02获取仓库文档
  3. 03语义搜索文档
  4. 04使用 GitHub Search API 搜索代码
  5. 05获取文档引用的 URL
  6. 06直接调用 MCP 工具

适用场景

  1. 01获取仓库 README 和文档
  2. 02查找特定问题的指南
  3. 03定位精确代码匹配
  4. 04调用仓库文档工具

MCP 相关

该技能通过命令行工具使用 gitmcp.io MCP 服务，提供仓库文档获取、搜索、代码搜索、URL 获取和直接工具调用。

安装

复制下面的命令，在终端中运行。

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

安装后在 Claude Code 中输入/read-github确认已加载。

附带文件scripts/gitmcp.py

详细介绍

阅读 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
搜索文档

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

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 仓库后，首先获取文档以了解项目
  2. 针对用法或功能的具体问题，使用 search-docs
  3. 使用 search-code 查找实现或特定函数
  4. 使用 fetch-url 获取文档中提及的外部参考

评论

支持 Markdown