README
🚀 GitHub MCP 服务器
GitHub MCP 服务器是一个与 GitHub 平台集成的 Model Context Protocol (MCP) 服务器。通过 API 交互,它能实现代码搜索、问题管理、拉取请求审查等功能,极大提升了开发者在 GitHub 上的操作效率。
✨ 主要特性
- 代码搜索:支持依据语言、路径、文件扩展名等条件,进行精确的代码搜索。
- 问题和拉取请求管理:可创建、更新、查询和删除问题及拉取请求。
- 评论和审查:能够添加、获取、更新和删除代码评论及审查意见。
- 仓库操作:可获取仓库信息,涵盖分支、标签、 collaborators 等。
- 搜索语法支持:提供强大的 GitHub 搜索语法,支持语言筛选、路径限定、标签过滤等功能。
📚 详细文档
API 端点
代码搜索
/code/search- 参数:
q:必填。搜索查询字符串。language:可选。指定编程语言。repo:可选。指定具体仓库,格式为owner/name。path:可选。指定文件路径。extension:可选。指定文件扩展名。
问题管理
/issues- 参数:
q:可选。搜索查询字符串。is:可选。过滤类型,支持issue或pr。state:可选。过滤状态,支持open或closed。label:可选。指定标签。
审查和评论
/pulls/reviews- 参数:
pull_number:必填。指定拉取请求编号。comments:可选。获取审查意见。
仓库信息
/repos/{owner}/{name}- 返回指定仓库的详细信息,包括分支、标签等。
搜索查询语法
代码搜索示例
q: "import express" language:typescript path:src/
问题搜索示例
q: "memory leak" is:issue is:open label:bug author:username
用户搜索示例
q: "fullstack developer" location:London followers:>1000 type:user
📦 安装指南
个人访问令牌
为了使用 GitHub MCP 服务器,需要创建一个具有适当权限的 GitHub 个人访问令牌:
- 访问 Personal access tokens。
- 点击“生成新令牌”按钮。
- 选择所需的权限范围(如 repo、admin:repo)。
- 复制并保存生成的令牌。
Docker 配置
构建镜像
docker build -t github-mcp-server .
运行容器
docker run --name mcp-server \
-p 3000:3000 \
-e GITHUB_TOKEN=your_token_here \
github-mcp-server
Claude 桌面版配置
在 Claude 桌面版 中,可以通过以下方式配置 GitHub MCP 服务器:
JSON 配置示例
{
"name": "GitHub MCP Server",
"type": "docker",
"image": "github-mcp-server:latest",
"args": ["--port", "3000"],
"envs": {
"GITHUB_TOKEN": "your_token_here"
}
}
📄 许可证
本项目遵循 MIT 许可证,允许自由使用、修改和分发,但需保留版权声明和许可信息。
Scan to join WeChat group