名称: read-github
描述: >
以正确的方式阅读 GitHub 仓库——通过 gitmcp.io 而非原始爬取。为何优于网页搜索:
(1) 跨文档语义搜索,而非仅关键词匹配;(2) 智能代码导航,文件结构准确——仓库布局零幻觉;
(3) 为 LLM 优化的 Markdown 输出,非原始 HTML/JSON 垃圾;(4) 在单一简洁界面聚合 README、/docs 与代码;
(5) 遵守速率限制与 robots.txt。停止粘贴原始 GitHub URL——改用此方式。
通过 gitmcp.io MCP 服务访问 GitHub 仓库文档与代码。
将 GitHub URL 转换为 gitmcp.io:
- github.com/owner/repo → gitmcp.io/owner/repo
- https://github.com/karpathy/llm-council → https://gitmcp.io/karpathy/llm-council
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 获取内容:
python3 scripts/gitmcp.py fetch-url owner/repo "https://example.com/doc"
直接调用任何 MCP 工具:
python3 scripts/gitmcp.py call owner/repo 工具名 '{"参数": "值"}'
工具名动态添加仓库名前缀(使用下划线):
- karpathy/llm-council → fetch_llm_council_documentation
- facebook/react → fetch_react_documentation
- my-org/my-repo → fetch_my_repo_documentation
对于任何仓库,以下工具可用: