README
🚀 GitHub MCP 服务器
GitHub MCP(模型上下文协议)服务器可与 GitHub 平台进行交互,涵盖代码搜索、问题管理、拉取请求审查等各类用户和仓库相关操作,能有效提升开发者在 GitHub 上的工作效率。
🚀 快速开始
若要使用 GitHub MCP 服务器,你需先创建 GitHub 个人访问令牌以获取相应权限,然后在 claude-desktop 配置文件中添加设置信息,可选择使用 Docker 或 NPX 来启动服务器。具体步骤如下:
- 创建个人访问令牌:登录 GitHub,进入 开发者设置,创建新令牌并选择所需的仓库访问权限(建议选择“Full control of private repositories”),最后复制生成的令牌。
- 在
claude-desktop中配置:- 使用 Docker:
// 启动 MCP 服务器容器
docker run -it --name mcp-server \
-e GITHUB_TOKEN="your_token_here" \
your-docker-image:tag
- **使用 NPX**:
npx @modelcontextprotocol/server-github \
--token "your_token_here" \
--port 3000
✨ 主要特性
- 代码搜索:支持通过编程语言、路径、文件扩展名等条件进行精确的代码查找。
- 问题管理:允许筛选和操作问题(issues)与拉取请求(pull requests),包括创建、更新和删除。
- 审查管理:能够获取和处理仓库中的评论和审查信息。
- 用户与仓库交互:支持查询用户资料、仓库详情以及参与的项目等。
📚 详细文档
核心 API 函数
以下是 MCP 服务器中实现的关键 GitHub 功能及其作用:
- 代码搜索
searchCode:根据特定条件查找代码片段。searchRepo:在指定仓库内进行代码搜索。
- 问题管理
getIssue:获取单个问题的详细信息。createIssue:创建新问题。
- 审查管理
getReview:获取拉取请求的审查详情。updateReview:更新现有审查状态和评论。
- 用户交互
getUser:获取用户资料信息。getRepository:获取指定仓库的信息。
搜索查询语法
代码搜索
language:javascript:按编程语言筛选。repo:owner/name:在特定仓库内搜索。path:app/src:按文件路径查找。extension:js:按文件扩展名筛选。- 示例:
q: "import express" language:typescript path:src/
问题搜索
is:issue或is:pr:按问题或拉取请求类型筛选。is:open或is:closed:按状态筛选。label:bug:按标签查找。author:username:按作者查找。- 示例:
q: "memory leak" is:issue is:open label:bug
用户搜索
type:user或type:org:按用户或组织类型筛选。followers:>1000:按关注者数量筛选。location:London:按地理位置查找。- 示例:
q: "fullstack developer" location:London followers:>100
更多详细搜索语法,请参考 GitHub 搜索文档。
📄 许可证
GitHub MCP 服务器采用 MIT 许可证,允许用户自由使用、修改和分发此软件,但需在重新分发时包含原始版权声明。
Scan to join WeChat group