Code Review MCP Server

🚀 用于 Cursor 的 MCP 工具代码审查工具

此工具是基于模型上下文协议 (MCP) 的 Cursor 插件，可自动生成 git 差分并执行代码审查，为代码审查工作提供了高效且便捷的解决方案。

✨ 主要特性

• 🔍 比较两个 Git 分支之间的代码差异。
• 🌐 从 GitHub 拉取请求 URL 进行比较代码差异。
• 💬 在 GitHub 拉取请求中添加总结评论。
• 📝 添加特定行的评论到 GitHub 拉取请求中。
• 📖 提供详细的代码审查指南。
• 📌 支持 Notion 集成，从 Notion 代码块中获取审查指南，默认指南作为备用。
• 🎨 包含预配置的样式和代码审查指南。

📦 安装指南

GitHub CLI 安装

此工具要求在您的机器上全局安装 GitHub 命令行接口：

# MacOS
brew install gh

# Windows
winget install -e --id GitHub.cli

# Linux
sudo apt install gh  # Debian/Ubuntu

安装完成后，使用您的 GitHub 账户进行身份验证：

gh auth login

有关更多安装选项，请访问 GitHub CLI 文档。

🚀 快速开始

Cursor 配置

要在 Cursor 中使用此工具，请在 Cursor 设置中添加以下配置：

1. 打开 Cursor 设置（通常位于 ~/.cursor/config.json）。
2. 添加以下配置：

{
  "mcpServers": {
    "code-review-tool": {
      "command": "npx",
      "args": ["-y", "code-review-mcp-server"],
      "env": {
        "NOTION_API_KEY": "notion_api_key",
        "NOTION_CODE_REVIEW_GUIDELINE_CODE_BLOCK_URL": "notion_code_block_url_here",
        "NOTION_STYLE_GUIDELINE_CODE_BLOCK_URL": "notion_style_guideline_url_here"
      }
    }
  }
}

参考文档：Cursor 模型上下文协议。

Notion 集成设置

1. 请求 Notion API 令牌

1. 访问 Notion 开发者。
2. 创建新的集成。
3. 获取 API 令牌。 详细说明请参阅：Notion API 授权指南。

2. 配置环境变量

工具需要以下环境变量：

NOTION_API_KEY=your_token_here
NOTION_CODE_REVIEW_GUIDELINE_CODE_BLOCK_URL=your_notion_code_block_url
NOTION_STYLE_GUIDELINE_CODE_BLOCK_URL=your_notion_style_guideline_url

这些可以在上述 Cursor 配置的 env 部分中提供。

3. 将集成添加到 Notion 页面

1. 点击页面的 共享 按钮。
2. 将您的集成添加到页面的共享列表中。 注意：目前仅支持从 Notion 阅读代码块。 详细说明请参阅：Notion API 连接指南。

💻 使用示例

本地 Git 分支审查

在 Cursor 聊天窗口中输入以下命令：

code review
base分支: branch/any_branch

此操作将：

1. 比较当前分支与指定基础分支之间的差异。
2. 自动生成 git 差分。
3. 根据样式和代码审查指南执行审查。
4. 提供详细审查结果和改进建议。

GitHub PR 审查

在 Cursor 聊天窗口中输入以下命令：

code review
https://github.com/owner/repo/pull/123

生成审查报告后，请执行以下操作：
1. 添加 PR 总结评论。
2. 直接在提供的代码中使用 **行注释** 提供特定改进意见。

此操作将获取 PR 的 diff 并提供代码审查。

📚 详细文档

审查指南

• 🔍 比较两个 Git 分支之间的代码差异。
• 🌐 从 GitHub 拉取请求 URL 进行比较代码差异。
• 💬 在 GitHub 拉取请求中添加总结评论。
• 📝 添加特定行的评论到 GitHub 拉取请求中。
• 📖 提供详细的代码审查指南。
• 📌 支持 Notion 集成，从 Notion 代码块中获取审查指南，默认指南作为备用。
• 🎨 包含预配置的样式和代码审查指南。