代码审查服务器

一个使用 Repomix 和大型语言模型 (LLM) 进行代码审查的自定义 MCP 服务器。

特性

• 使用 Repomix 扁平化代码库
• 使用大型语言模型分析代码
• 获取具有具体问题和建议的结构化代码审查
• 支持多个 LLM 提供商（OpenAI, Anthropic, Gemini）
• 处理大型代码库的分块

安装

# Clone the repository
git clone https://github.com/yourusername/code-review-server.git
cd code-review-server

# Install dependencies
npm install

# Build the server
npm run build

配置

在根目录下根据 .env.example 模板创建一个 .env 文件：

cp .env.example .env

编辑 .env 文件以设置您首选的 LLM 提供商和 API 密钥：

# LLM Provider Configuration
LLM_PROVIDER=OPEN_AI
OPENAI_API_KEY=your_openai_api_key_here

使用

作为 MCP 服务器

代码审查服务器实现了 Model Context Protocol (MCP)，可以与任何 MCP 客户端一起使用：

# Start the server
node build/index.js

该服务器提供了两个主要工具：

1. analyze_repo: 使用 Repomix 扁平化代码库
2. code_review: 使用 LLM 进行代码审查

何时使用 MCP 工具

此服务器提供了两个不同的工具，用于满足不同的代码分析需求：

analyze_repo

在以下情况下使用此工具：

• 获取代码库结构和组织的高层次概览
• 将仓库扁平化为文本表示形式进行初步分析
• 无需详细审查即可了解目录结构和文件内容
• 准备更深入的代码审查
• 快速扫描代码库以识别进一步分析的相关文件

示例场景：

• "我想在审查之前了解这个仓库的结构"
• "显示这个代码库中的文件和目录"
• "给我一个扁平化的视图来理解其组织"

code_review

在以下情况下使用此工具：

• 进行全面的代码质量评估
• 识别特定的安全漏洞、性能瓶颈或代码质量问题
• 获得可操作的改进建议
• 进行带有严重性评级的详细审查
• 根据最佳实践评估代码库

示例场景：

• "审查此代码库的安全漏洞"
• "分析这些特定 JavaScript 文件的性能"
• "给我这个仓库的详细代码质量评估"
• "审查我的代码并告诉我如何提高其可维护性"

何时使用参数：

• specificFiles: 当你只想审查某些文件而不是整个仓库时
• fileTypes: 当你想专注于特定文件扩展名（如 .js, .ts）时
• detailLevel: 使用 'basic' 进行快速概览或 'detailed' 进行深入分析
• focusAreas: 当你想优先考虑某些方面（安全、性能等）时

使用 CLI 工具

为了测试目的，您可以使用附带的 CLI 工具：

node build/cli.js <repo_path> [options]

选项：

• --files <file1,file2>: 具体要审查的文件
• --types <.js,.ts>: 包含在审查中的文件类型
• --detail <basic|detailed>: 详细程度（默认：detailed）
• --focus <areas>: 重点关注的领域（security,performance,quality,maintainability）

示例：

node build/cli.js ./my-project --types .js,.ts --detail detailed --focus security,quality

开发

# Run tests
npm test

# Watch mode for development
npm run watch

# Run the MCP inspector tool
npm run inspector

LLM 集成

代码审查服务器直接与多个LLM提供商的API集成：

• OpenAI（默认：gpt-4o）
• Anthropic（默认：claude-3-opus-20240307）
• Gemini（默认：gemini-1.5-pro）

提供商配置

在.env文件中配置您首选的LLM提供商：

# Set which provider to use
LLM_PROVIDER=OPEN_AI  # Options: OPEN_AI, ANTHROPIC, or GEMINI

# Provider API Keys (add your key for the chosen provider)
OPENAI_API_KEY=your-openai-api-key
ANTHROPIC_API_KEY=your-anthropic-api-key
GEMINI_API_KEY=your-gemini-api-key

模型配置

您可以选择为每个提供商指定使用哪个模型：

# Optional: Override the default models
OPENAI_MODEL=gpt-4-turbo
ANTHROPIC_MODEL=claude-3-sonnet-20240229
GEMINI_MODEL=gemini-1.5-flash-preview

LLM集成工作原理

1. code_review工具使用Repomix处理代码，以扁平化仓库结构。
2. 如果需要，代码将被格式化并分块，以适应LLM上下文限制。
3. 根据关注点和详细程度生成详细的提示。
4. 提示和代码直接发送到您选择的提供商的LLM API。
5. 解析LLM响应为结构化格式。
6. 代码审查结果以JSON对象的形式返回，包含问题、优点和建议。

实现包括针对API错误的重试逻辑以及适当的格式化，以确保最相关的代码被纳入审查。

代码审查输出格式

代码审查以结构化的JSON格式返回：

{
  "summary": "Brief summary of the code and its purpose",
  "issues": [
    {
      "type": "SECURITY|PERFORMANCE|QUALITY|MAINTAINABILITY",
      "severity": "HIGH|MEDIUM|LOW",
      "description": "Description of the issue",
      "line_numbers": [12, 15],
      "recommendation": "Recommended fix"
    }
  ],
  "strengths": ["List of code strengths"],
  "recommendations": ["List of overall recommendations"]
}

许可证

MIT