关键词

代码评审Git差异NeovimMCPMarkdown文件

项目简介

Git Diff Reviewer MCP Server 是一个实现了 Model Context Protocol (MCP) 的后端服务器，专注于为代码评审场景提供上下文信息。它通过工具 (Tools) 提供 Git 仓库的差异比较、文件列表和代码审查能力，并通过资源 (Resources) 暴露项目中的 Markdown 文件。此服务器设计用于与支持 MCP 协议的客户端（如 Neovim 插件 mcphub.nvim）配合使用，为开发者在代码编辑器中进行代码审查提供便利。

主要功能点

  • 获取 Git 差异 (get-git-diff): 比较当前分支与默认主分支 (origin/main 或 origin/master) 之间的代码差异。
  • 列出变更文件 (get-changed-files): 获取当前分支中所有已修改的文件列表。
  • 生成代码审查 (review-code-changes): 提供当前分支代码变更的详细审查信息，可选择详细程度。
  • 访问 Markdown 文件 (markdown-files): 允许客户端访问项目根目录下的 Markdown 文件（包括 README 和 LICENSE）。

安装步骤

  1. 确保已安装 Node.js 和 npm: Git Diff Reviewer MCP Server 基于 Node.js 运行，请确保你的开发环境已安装 Node.js 和 npm 包管理器。
  2. 克隆仓库: 将 'oraculo-reviewer' 仓库克隆到本地。
  3. 安装依赖: 在仓库根目录下运行 'npm install' 或 'yarn install' 命令安装项目依赖。

服务器配置

为了让 MCP 客户端（如 'mcphub.nvim'）连接到 Git Diff Reviewer MCP Server，您需要在客户端配置中指定服务器的启动信息。以下是 'mcphub.nvim' 的配置示例，展示了如何配置此 MCP 服务器：

{
  "servers": [
    {
      "name": "git-diff-reviewer",  // 服务器名称，客户端用于识别和调用
      "command": "node",         // 启动服务器的命令，这里使用 node.js 运行
      "args": ["src/index.ts"],   // 启动命令的参数，指向服务器入口文件。如果需要指定端口和工作目录，可以通过环境变量 PORT 和 WORKING_DIR 设置。例如 args 可以设置为 ["src/index.ts"]，并通过 export PORT=6002 设置端口
      "working_dir": "/path/to/oraculo-reviewer" // (可选) 服务器的工作目录，默认为启动命令的目录。如果你的项目根目录不是启动命令的目录，请指定此项。
    }
  ]
}

注意:

  • 上述 'args' 配置假设你直接运行 'src/index.ts' 文件。在实际部署中，你可能需要先构建项目，并将 'args' 指向构建后的入口文件（例如 'dist/index.js'）。
  • 'working_dir' 应替换为 'oraculo-reviewer' 仓库在您本地的实际路径。
  • 如果需要更改服务器端口，可以通过设置环境变量 'PORT' 来实现，例如在启动服务器前执行 'export PORT=6002'。

基本使用方法

  1. 启动服务器: 在仓库根目录下，运行命令 'npm run start' (如果 package.json 中配置了 start 脚本，或者直接使用 'node src/index.ts' 或 'ts-node src/index.ts' 如果全局安装了 ts-node)。服务器默认会在 6001 端口启动。
  2. 配置 MCP 客户端: 根据你的 MCP 客户端（如 'mcphub.nvim'）的文档，配置服务器连接信息，将上述服务器配置添加到客户端的配置文件中。
  3. 在客户端中使用: 连接成功后，你就可以在 MCP 客户端中调用 Git Diff Reviewer 服务器提供的工具和资源，例如获取代码差异、查看变更文件列表或访问 Markdown 文档，以辅助代码审查工作。具体调用方法请参考 MCP 客户端的使用说明。

信息

分类

开发者工具

访问项目