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 代碼塊中獲取審查指南，默認指南作為備用。
• 🎨 包含預配置的樣式和代碼審查指南。