Code Review MCP

🚀 代码审查MCP — 以Cursor为先的PR审查工具

代码审查MCP是一个端到端的解决方案，它利用你本地的工具链和Cursor的AI来审查GitHub上的拉取请求（PR）。它可以获取PR的差异，加载项目文档，运行静态分析、安全检查和测试，在允许的情况下发布内联评论，并生成Markdown报告。

🚀 快速开始

代码审查MCP借助本地工具链和Cursor的AI，实现对GitHub拉取请求的端到端审查。它能获取PR差异、加载项目文档、执行各类检查与测试、发布评论并生成报告。

✨ 主要特性

• 自动化审查：自动拉取PR差异，结合项目文档进行综合审查。
• 多工具集成：支持ESLint、Prettier、TypeScript、Semgrep和Playwright等工具。
• 环境灵活配置：可通过.env.mcp文件或命令行指定环境变量。
• 报告生成：生成Markdown格式的详细审查报告。

📦 安装指南

1. 克隆此仓库（或者将tools/mcp-code-review.mjs和.mcp/code-review/复制到你的项目仓库中）。
2. 在仓库中安装Node依赖：npm ci（或者npm i）。
3. 确保.cursor/mcp.json指向tools/mcp-code-review.mjs的绝对路径。

示例.cursor/mcp.json文件：

{
  "mcpServers": {
    "code-review": {
      "command": "node",
      "args": ["/absolute/path/to/tools/mcp-code-review.mjs"]
    }
  }
}

💻 使用示例

基础用法

在目标仓库的Cursor聊天框中，你可以使用以下命令触发审查：

• @code-review 123（自动从git origin检测仓库）
• @code-review owner/repo#123
• @code-review https://github.com/owner/repo/pull/123
• @code-review latest

高级用法

你可以使用以下标志来定制审查过程：

• --env-file=/abs/path/to/.env.mcp（覆盖默认的环境文件）
• --dry-run（跳过发布评论，仍然生成报告）
• --commit-report（在允许的情况下将报告提交到PR分支）
• --auto-fix 或 --auto-fix=force（应用ESLint/Prettier修复，提交并推送）
• --skip-static --skip-security --skip-tests --skip-figma
• --semgrep-rules-dir=/path/to/rules（覆盖Semgrep规则）
• --max-diff-chars=20000 --max-file-hunks=10 --verbose

📚 详细文档

环境配置（认证）

• MCP默认只加载.env.mcp（仓库根目录），或者使用--env-file=/path/to/env指定其他文件。
• 必需配置：
  • GITHUB_TOKEN=...（必须有权限访问目标仓库；如果组织强制要求SSO，则需要经过SSO授权）
• 可选配置：
  • JIRA_BASE_URL、JIRA_EMAIL、JIRA_API_KEY
  • FIGMA_TOKEN
  • SEMGREP_RULES_DIR=.mcp/code-review/semgrep-rules

自动检测的项目文件

• 仓库文档（AI上下文）：
  • 仓库根目录下的codebase_structure.md和watchouts.md
  • .mcp/code-review/下的所有.md文件（例如your-rules.md）
• 代码检查/格式化/类型检查：
  • 使用项目配置从本地node_modules/.bin运行ESLint/Prettier。
  • 如果存在tsconfig.json，则运行TypeScript检查。
• 安全检查：
  • 如果存在.mcp/code-review/semgrep-rules/，则使用其中的Semgrep规则；否则使用p/ci规则。
• 测试：
  • 如果仓库根目录存在playwright.config.ts/js，则运行Playwright测试。

输出信息

• 日志：mcp-logs/（每次运行的日志文件）
• 工件：mcp-artifacts/<owner>-<repo>-PR<#>-<ts>/
• 报告：mcp-reports/code-review-<owner>-<repo>-PR<#>-<ts>.md

注意事项

• 如果认证用户是PR的作者，GitHub可能会拒绝发布审查评论；MCP将跳过评论，但仍然会生成报告（请查看报告中的管道状态）。
• 旧的日志/报告（超过1天）将被清理，每个PR只保留最新的报告。

子工具（高级用法）

你可以直接调用以下子工具：

• @github.resolve_pr { prId: "owner/repo#123" }
• @github.fetch_files { owner: "owner", repo: "repo", pull_number: 123 }
• @jira.fetch { prMeta: { title: "...", body: "...", branch: "..." } }
• @analysis.run_static { files: ["src/..."], runTsc: true }
• @security.run_semgrep {}
• @tests.run_playwright {}
• @report.generate {...}
• @cleanup.prune { owner:"owner", repo:"repo", pull_number:123 }

CI建议

为了保证一致性，建议在CI中运行相同的工具：

• ESLint: npx eslint . --max-warnings=0
• Prettier: npx prettier --check .
• Semgrep: pipx install semgrep && semgrep --config .mcp/code-review/semgrep-rules --error -- .
• Playwright: npx playwright install --with-deps && npx playwright test --reporter=line

故障排除

• 凭证问题：确保.env.mcp文件存在，并且日志显示Auth loaded from .env.mcp:...。验证PAT：curl -H "Authorization: Bearer $GITHUB_TOKEN" https://api.github.com/user → 响应状态码必须为200。
• Jira跳过：确保PR分支/标题/正文中包含Jira关键字，并且JIRA_*环境变量已设置。
• Semgrep跳过：安装Semgrep CLI或设置规则目录。
• Playwright跳过：添加playwright.config.*文件并安装浏览器。

有关特定平台（macOS/Windows）的设置，请参阅docs/Platform-Setup.md。

🔧 技术细节

代码审查MCP基于Node.js 18+构建，通过调用各种工具和API实现对GitHub PR的审查。它利用Cursor的AI能力，结合项目文档和规则，提供全面的审查报告。在运行过程中，它会自动检测项目中的各种配置文件和工具，根据环境变量进行认证和配置。通过调用子工具，可以实现更细粒度的操作。

📄 许可证

文档中未提及相关许可证信息。