OA0
OA0 是一个探索 AI 的社区
现在注册
已注册用户请  登录
OA0  ›  技能包  ›  read-github:通过 gitmcp.io 访问 GitHub 仓库文档与代码

read-github:通过 gitmcp.io 访问 GitHub 仓库文档与代码

 
  charge ·  2026-02-02 15:31:51 · 20 次点击  · 0 条评论  

名称: read-github
描述: >
以正确的方式阅读 GitHub 仓库——通过 gitmcp.io 而非原始爬取。为何优于网页搜索:
(1) 跨文档语义搜索,而非仅关键词匹配;(2) 智能代码导航,文件结构准确——仓库布局零幻觉;
(3) 为 LLM 优化的 Markdown 输出,非原始 HTML/JSON 垃圾;(4) 在单一简洁界面聚合 README、/docs 与代码;
(5) 遵守速率限制与 robots.txt。停止粘贴原始 GitHub URL——改用此方式。


阅读 GitHub 文档

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

URL 转换

将 GitHub URL 转换为 gitmcp.io:
- github.com/owner/repogitmcp.io/owner/repo
- https://github.com/karpathy/llm-councilhttps://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 "查询内容"

搜索代码

使用 GitHub 搜索 API(精确匹配)搜索代码:

python3 scripts/gitmcp.py search-code owner/repo "函数名"

获取引用的 URL

从文档中提及的 URL 获取内容:

python3 scripts/gitmcp.py fetch-url owner/repo "https://example.com/doc"

直接调用工具

直接调用任何 MCP 工具:

python3 scripts/gitmcp.py call owner/repo 工具名 '{"参数": "值"}'

工具命名

工具名动态添加仓库名前缀(使用下划线):
- karpathy/llm-councilfetch_llm_council_documentation
- facebook/reactfetch_react_documentation
- my-org/my-repofetch_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 检索文档中提及的外部引用
20 次点击  ∙  0 人收藏  
登录后收藏  
0 条回复
关于 ·  帮助 ·  PING ·  隐私 ·  条款   
OA0 - Omni AI 0 一个探索 AI 的社区
沪ICP备2024103595号-2
耗时 14 ms
Developed with Cursor