Code Review

🚀 代码审查服务器

代码审查服务器是一个自定义的MCP服务器，它借助Repomix和大语言模型（LLMs）来执行代码审查，能有效帮助开发者提升代码质量，快速定位并解决代码中的问题。

🚀 快速开始

本代码审查服务器的使用步骤较为清晰，下面为您详细介绍。

安装

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

# 安装依赖项
npm install

# 构建服务器
npm run build

配置

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

cp .env.example .env

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

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

启动

# 启动服务器
node build/index.js

✨ 主要特性

• 代码库扁平化：使用Repomix扁平化代码库，方便快速浏览代码库的整体情况。
• 大语言模型分析：利用大语言模型分析代码，深入挖掘代码中的潜在问题。
• 结构化审查结果：获取结构化的代码审查结果，包括具体问题和建议，让您对代码问题一目了然。
• 多LLM供应商支持：支持多个LLM供应商（OpenAI、Anthropic、Gemini），您可以根据需求自由选择。
• 大型代码库处理：能够处理大型代码库的分块，确保对大型项目的有效审查。

📦 安装指南

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

# 安装依赖项
npm install

# 构建服务器
npm run build

💻 使用示例

作为MCP服务器

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

# 启动服务器
node build/index.js

服务器暴露了两个主要工具：

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

使用MCP工具的时机

此服务器为不同的代码分析需求提供了两种不同的工具：

analyze_repo

当您需要以下内容时使用此工具：

• 扁平化代码库结构
• 快速浏览代码库的整体情况

code_review

当您需要以下内容时使用此工具：

• 深入分析代码的质量和安全问题
• 获取具体的改进建议

代码审查服务器的输出格式

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

{
  "summary": "代码及其目的的简要摘要",
  "issues": [
    {
      "type": "SECURITY|PERFORMANCE|QUALITY|MAINTAINABILITY",
      "severity": "HIGH|MEDIUM|LOW",
      "description": "问题描述",
      "line_numbers": [12, 15],
      "recommendation": "推荐的修复方法"
    }
  ],
  "strengths": ["代码优势列表"],
  "recommendations": ["总体改进建议列表"]
}

📄 许可证

本项目采用MIT许可证。