GitHub仓库阅读

技能简介

read-github 技能通过 gitmcp.io MCP 服务访问 GitHub 仓库的文档和代码，替代传统的原始抓取方式。该服务提供语义搜索、智能代码导航、规范的 Markdown 输出，并聚合 README、/docs 目录和代码文件。

能做什么

• 将 GitHub URL 转换为 gitmcp.io 格式进行访问
• 获取仓库完整文档（README、docs 等）
• 在文档内进行语义搜索，而非简单的关键词匹配
• 通过 GitHub Search API 精确搜索代码
• 获取文档中引用的外部链接内容
• 动态生成带仓库前缀的 MCP 工具名称

使用说明

安装依赖

需安装 Python 3 环境，克隆仓库后使用 scripts/gitmcp.py 脚本：

git clone https://github.com/openclaw/skills.git
cd skills/am-will/read-github

基础用法

1. 列出可用工具：

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

2. 获取完整文档：

python3 scripts/gitmcp.py fetch-docs owner/repo

3. 语义搜索文档：

python3 scripts/gitmcp.py search-docs owner/repo "查询内容"

4. 搜索代码：

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

5. 调用任意 MCP 工具：

python3 scripts/gitmcp.py call owner/repo tool_name '{"arg": "value"}'

URL 转换规则

github.com/owner/repo → gitmcp.io/owner/repo

输入与输出

见下方输入与输出表格。

风险提示

• 需遵守 gitmcp.io 的速率限制
• 部分私有仓库可能无法访问
• 外部链接获取受 robots.txt 限制
• 工具名称随仓库名动态变化，调用前需确认

来源信息

原始链接：https://github.com/openclaw/skills/tree/main/skills/am-will/read-github/SKILL.md
来源类型：GitHub 开源项目