article
README
🚀 GitHub MCP 服务器
GitHub MCP 服务器是一个强大的接口,可实现与 Claude 模型的交互。它具备多种实用功能,能帮助用户在 GitHub 上高效地进行代码搜索、问题追踪、仓库操作以及用户与团队管理等工作。
✨ 主要特性
- 代码搜索:可在特定仓库或路径中精准搜索代码片段。
- 问题追踪:方便查看和管理问题(Issues)及拉取请求(Pull Requests)。
- 仓库操作:能够获取仓库信息、分支、标签等元数据。
- 用户与团队管理:支持操作用户资料、关注状态及其他社交数据。
💻 使用示例
基础用法
# 代码搜索示例
mcp.github.search.code(q="import express", language=javascript, repo="owner/repo")
# 获取问题列表
mcp.github.search.issues(q="memory leak is:issue is:open label:bug")
# 用户搜索
mcp.github.search.users(q="fullstack developer", location=London, followers:>100)
📚 详细文档
MCP 函数参考
代码搜索
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 个人访问令牌的步骤如下:
- 访问 Personal access tokens
- 选择所需仓库权限(Public, All 或自定义)
- 创建带有
repo权限的令牌 - 复制生成的令牌
集成到 Claude Desktop
在 claude_desktop_config.json 中添加以下配置:
Docker 方式
{
"mcpServers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"mcp/github"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
NPX 方式
{
"mcpServers": {
"github": {
"command": "npx",
"args": [
"mcp/github"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
🔧 技术细节
- 使用 Node.js 和 npm 进行开发。
- 参考
package.json配置项目依赖。 - 代码遵循 MIT 协议,需签署 CLA。
📄 许可证
本项目代码遵循 MIT 协议,需签署 CLA。
微信扫一扫