使用说明

项目简介

'claude-code-review-mcp' 是一个基于 Model Context Protocol (MCP) 标准构建的应用后端服务。它通过提供代码审查、模型列表等功能,使任何兼容MCP的客户端(如Claude Code, Claude Desktop, Cursor, Windsurf等)能够利用多种大型语言模型(包括OpenAI、Google Gemini、Anthropic Claude)进行代码分析和获取反馈。它作为一个“第二意见”工具,增强了代码审查的工作流。

主要功能点

  • 多模型支持: 集成OpenAI、Google、Anthropic等主流AI模型的API,用户可根据配置选择不同的模型进行代码审查。
  • 灵活的审查模式: 提供结构化审查(分章节反馈如bugs, improvements, security等)和自由形式叙述性审查两种模式。
  • 上下文感知: 支持包含项目结构、相关文件、提交信息和依赖等上下文信息,使审查更准确、关联性更强。
  • 智能处理: 自动识别代码语言、处理大文件(进行截断),并优化输出格式,提高易读性。
  • 高兼容性: 通过MCP协议与多种客户端无缝对接,并包含专门的兼容性增强处理,确保稳定通信。
  • 简单配置: 通过环境变量轻松设置API密钥和服务器参数。

安装步骤

  1. 确保您的系统已安装 Node.js (版本 18.0.0 或更高)。
  2. 打开终端或命令行工具。
  3. 执行以下命令进行全局安装:
    npm install -g claude-code-review-mcp
  4. 或者,您可以使用 'npx' 无需全局安装即可直接运行(推荐用于临时测试):
    # 设置环境变量后运行
    export OPENAI_API_KEY=你的OpenAI密钥
    npx -y claude-code-review-mcp
    
    # 或直接在命令前设置环境变量
    GOOGLE_API_KEY=你的Google密钥 npx -y claude-code-review-mcp

服务器配置 (用于MCP客户端)

MCP客户端(如Claude Code, Claude Desktop等)需要配置如何启动并连接到此MCP服务器。以下是如何在客户端中配置的通用指南:

您需要在客户端的MCP服务器配置中指定启动此服务的命令 ('command') 及其参数 ('args')。同时,必须通过环境变量 ('env') 提供至少一个AI服务商的API密钥。

  • 服务器名称 (Name): 给您的MCP服务器连接起一个名称,例如 'code-review'。
  • 启动命令 (Command): 根据您的安装方式选择:
    • 如果您选择 'npx' 方式:命令是 'npx'。
    • 如果您选择 全局安装方式:命令是 'claude-code-review-mcp'。
  • 命令参数 (Args): 根据您的安装方式选择:
    • 如果您选择 'npx' 方式:参数是 '["-y", "claude-code-review-mcp"]'。
    • 如果您选择 全局安装方式:参数留空 '[]'。
  • 环境变量 (Environment Variables - env): 添加您的AI服务商API密钥。这是一个包含键值对的对象,例如:
    {
      "OPENAI_API_KEY": "你的OpenAI密钥",
      "GOOGLE_API_KEY": "你的Google密钥",
      "ANTHROPIC_API_KEY": "你的Anthropic密钥"
    }
    您只需提供至少一个有效的密钥。例如,如果您只想使用OpenAI模型,只需包含 '"OPENAI_API_KEY": "你的OpenAI密钥"'。

请参考您的MCP客户端的具体文档,将上述信息配置到相应的MCP服务器设置中。

基本使用方法

  1. 通过您的MCP客户端配置启动 'claude-code-review-mcp' 服务器。服务器启动时,您可以在客户端或服务器的日志中看到监听的端口信息。
  2. 在您的MCP客户端界面中,通过您配置的服务器名称(例如 'code-review')访问其提供的工具。
  3. 该MCP服务器提供了三个主要工具:
    • 'reviewCodeStructured': 提交代码并请求结构化代码审查。
    • 'reviewCodeFreeform': 提交代码并请求自由形式的代码审查。
    • 'listModels': 查看当前服务器配置下可用的AI模型列表。
  4. 在客户端的交互界面中,调用这些工具并提供必要的输入(例如要审查的代码和选择的模型ID)。具体调用方式取决于您的MCP客户端。例如,在Claude Code CLI中,可能会通过自定义命令(如 '/project:structured-review')或直接的MCP调用命令进行交互。运行 'listModels' 工具可以帮助您确定可用的模型ID。

其他配置 (环境变量)

除了API密钥,您还可以通过以下环境变量配置服务器行为:

  • 'PORT': 指定服务器监听的端口(默认为动态分配一个可用端口,设为0)。
  • 'HOST': 指定服务器监听的地址(默认为 '127.0.0.1')。
  • 'LOG_LEVEL': 设置日志输出级别 (0=DEBUG, 1=INFO, 2=WARN, 3=ERROR; 默认为 1)。

信息

分类

开发者工具