README
🚀 代码审查 MCP 服务器
本项目是一个使用 Model Context Protocol 的 GitHub 拉取请求代码审查服务器,它集成了 OpenRouter 的 AI 模型,能够自动化进行代码审查并提供详细反馈,助力开发者提升代码质量。
🚀 快速开始
本服务器可实现自动化的 GitHub 拉取请求代码审查,为开发者提供代码质量、风格及潜在问题的详细反馈,同时支持全面的日志记录,方便调试。
要求
- GitHub 个人访问令牌 (PAT):具有
repo权限以访问私有仓库,或public_repo权限以访问公开仓库。此令牌用于获取拉取请求数据。 - OpenRouter API 密钥
安装
- 克隆此仓库:
git clone https://github.com/joaomj/code-reviewer-mcp.git
cd code-reviewer-mcp
- 安装依赖项:
npm install
- 设置必要的环境变量:
export GITHUB_PAT=your_github_personal_access_token
export OPENROUTER_API_KEY=your_openrouter_api_key
- 构建服务器:
npm run build
使用
启动 MCP 服务器:
node build/index.js
该服务器可供任何 MCP 兼容客户端(如 Claude Desktop)使用。
配置
在您的 MCP 客户端配置中添加以下内容:
{
"mcpServers": {
"code-reviewer-mcp": {
"command": "node",
"args": ["/path/to/code-reviewer-mcp/build/index.js"],
"env": {
"GITHUB_PAT": "your_github_token",
"OPENROUTER_API_KEY": "your_openrouter_key"
}
}
}
}
✨ 主要特性
- 自动化 GitHub 拉取请求代码审查,提高审查效率。
- 提供详细的代码质量、风格及潜在问题反馈,帮助开发者优化代码。
- 集成 OpenRouter 的 AI 模型(目前使用 Gemini 2.5 Pro),借助 AI 能力提升审查准确性。
- 全面的日志记录用于调试,方便排查问题。
📦 安装指南
克隆仓库
git clone https://github.com/joaomj/code-reviewer-mcp.git
cd code-reviewer-mcp
安装依赖
npm install
设置环境变量
export GITHUB_PAT=your_github_personal_access_token
export OPENROUTER_API_KEY=your_openrouter_api_key
构建服务器
npm run build
💻 使用示例
基础用法
启动 MCP 服务器:
node build/index.js
高级用法
在 MCP 客户端配置中添加服务器信息,实现客户端与服务器的集成:
{
"mcpServers": {
"code-reviewer-mcp": {
"command": "node",
"args": ["/path/to/code-reviewer-mcp/build/index.js"],
"env": {
"GITHUB_PAT": "your_github_token",
"OPENROUTER_API_KEY": "your_openrouter_key"
}
}
}
}
📚 详细文档
开发
- 使用自动重建:
npm run watch
- 运行测试:
npm test
调试
内置日志输出到 stderr,提供详细的调试信息,包括:
- GitHub API 请求
- OpenRouter API 调用
- 处理步骤
- 任何遇到的错误
高级调试可使用 MCP 检查器:
npm run inspector
下一步计划
未来改进和功能:
- [ ] 草稿拉取请求分析
- [ ] 自定义审查模板
- [ ] 支持多个 AI 模型(OpenAI、Claude 等)
- [ ] 文件特定反馈
- [ ] 速率限制与缓存
贡献
欢迎提出建议。请先打开问题讨论您希望更改的内容。
🔧 技术细节
目前该服务器主要依赖 GitHub 个人访问令牌和 OpenRouter API 密钥,通过集成 OpenRouter 的 AI 模型(如 Gemini 2.5 Pro)实现代码审查功能。在运行过程中,会进行全面的日志记录,方便调试和排查问题。
📄 许可证
文档未提及相关信息。
⚠️ 重要提示
目前该服务器仅支持开放的拉取请求(不支持草稿 PR)。
微信扫一扫