README
🚀 GitHub MCP 服务器
这是一个最小模型上下文协议(MCP)服务器,为 AI 助手提供聚焦于 GitHub 的工具。
🚀 快速开始
本地部署
# 1. 克隆仓库并安装依赖
git clone <repo-url>
cd github-review-mcp
pnpm install
# 2. 添加凭证
echo "GITHUB_TOKEN=ghp_your_token_here" > .env
# 3. 启动服务器
pnpm start
服务器将监听 MCP 客户端指定的端口(默认端口为 3000)。
从 MCP 客户端使用
Cursor IDE
将以下内容添加到 设置 → 扩展 → MCP(或者你的 mcp-servers.json 文件中):
{
"mcpServers": {
"github-review-server": {
"command": "node",
"args": ["/absolute/path/github-review-mcp/src/index.js"],
"env": { "GITHUB_TOKEN": "ghp_your_token_here" }
}
}
}
通用 MCP 客户端
将客户端指向 node /absolute/path/github-review-mcp/src/index.js,并在环境变量中传递 GITHUB_TOKEN。
Docker 部署(托管)
项目中包含了一个与托管镜像对应的 Dockerfile。
# 构建镜像
docker build -t gh-mcp .
# 运行容器
docker run -e GITHUB_TOKEN=ghp_your_token_here -p 3000:3000 gh-mcp
使用 http://localhost:3000(或映射的端口)作为命令,将容器连接到你的 MCP 客户端。
🔧 环境变量
| 变量 | 描述 | 默认值 |
| ---- | ---- | ---- |
| GITHUB_TOKEN | GitHub 个人访问令牌(必需) | - |
| MAX_PATCH_SIZE | 最大差异补丁大小(字符数) | 2000 |
| MAX_FILES_TO_REVIEW | 每个拉取请求处理的最大文件数 | 50 |
| REQUEST_TIMEOUT | HTTP 请求超时时间(毫秒) | 30000 |
| LOG_LEVEL | 日志记录级别(debug、info 等) | info |
| ENABLE_DEBUG | 详细日志记录(true/false) | false |
🛠️ 可用工具
核心的拉取请求实用工具以及高级分析模块:
get_review_prompts⭐(请先调用此工具!)get_pr_detailsget_pr_filesget_pr_commitsget_file_contentpost_pr_reviewget_repo_info
高级分析(🚀):
analyze_code_qualityanalyze_diff_impactdetect_security_issuesdetect_code_patternsanalyze_dependenciesanalyze_test_coveragegenerate_suggestions
如需详细的使用示例,请查看原始 README 历史记录或 src/tools/ 中的内联 JSDoc。
Scan to join WeChat group