代码审查服务器

一个使用 Repomix 和 LLM 执行代码审查的自定义 MCP 服务器。

功能特性

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

安装

# 克隆仓库
git clone https://github.com/yourusername/code-review-server.git
cd code-review-server

# 安装依赖
npm install

# 构建服务器
npm run build

配置

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

cp .env.example .env

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

# LLM 提供商配置
LLM_PROVIDER=OPEN_AI
OPENAI_API_KEY=your_openai_api_key_here

使用方法

作为 MCP 服务器

代码审查服务器实现了模型上下文协议 (MCP)，可以与任何 MCP 客户端一起使用：

# 启动服务器
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

开发

# 运行测试
npm test

# 观察模式进行开发
npm run watch

# 运行 MCP 检查器工具
npm run inspector

LLM 集成

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

• OpenAI (默认: gpt-4o)
• Anthropic (默认: claude-3-opus-20240307)
• Gemini (默认: gemini-1.5-pro)

提供商配置

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

# 设置要使用的提供商
LLM_PROVIDER=OPEN_AI  # 选项：OPEN_AI、ANTHROPIC 或 GEMINI

# 提供商 API 密钥（为所选提供商添加您的密钥）
OPENAI_API_KEY=your-openai-api-key
ANTHROPIC_API_KEY=your-anthropic-api-key
GEMINI_API_KEY=your-gemini-api-key

模型配置

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

# 可选：覆盖默认模型
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": "代码及其用途的简要摘要",
  "issues": [
    {
      "type": "SECURITY|PERFORMANCE|QUALITY|MAINTAINABILITY",
      "severity": "HIGH|MEDIUM|LOW",
      "description": "问题的描述",
      "line_numbers": [12, 15],
      "recommendation": "推荐的修复方法"
    }
  ],
  "strengths": ["代码优点的列表"],
  "recommendations": ["总体建议的列表"]
}

许可证

MIT