基本能力
产品定位
mcp-code-review-server 是一个专注于代码审查和分析的工具,旨在帮助开发者提高代码质量、识别潜在问题并提供改进建议。
核心功能
- 代码库扁平化:使用 Repomix 将代码库扁平化为文本表示形式,便于分析。
- 代码审查:利用大型语言模型 (LLMs) 进行详细的代码审查,识别安全漏洞、性能瓶颈和代码质量问题。
- 多 LLM 提供商支持:支持 OpenAI、Anthropic 和 Gemini 等多种 LLM 提供商。
- 分块处理:能够处理大型代码库的分块分析,确保在 LLM 上下文限制内完成审查。
- 结构化输出:生成结构化的 JSON 格式审查报告,包括问题、严重性、建议等。
适用场景
- 代码质量评估:对代码库进行全面的质量评估,识别潜在问题。
- 安全审查:检查代码中的安全漏洞和潜在风险。
- 性能优化:分析代码中的性能瓶颈并提供优化建议。
- 维护性改进:评估代码的可维护性,并提供改进建议。
工具列表
- analyze_repo:
- 能力:扁平化代码库结构,生成代码库的文本表示形式,便于初始分析。
-
适用场景:快速了解代码库的结构和组织,准备进行更深入的代码审查。
-
code_review:
- 能力:利用 LLMs 进行详细的代码审查,生成结构化的审查报告。
- 适用场景:需要详细代码质量评估、安全审查或性能优化的场景。
常见问题解答
- 如何配置 LLM 提供商?:在
.env
文件中设置LLM_PROVIDER
和相应的 API 密钥。 - 如何处理大型代码库?:服务器会自动分块处理代码,确保在 LLM 上下文限制内完成审查。
- 如何自定义审查重点?:通过
focusAreas
参数指定审查重点(如安全、性能、质量等)。
使用教程
使用依赖
确保已安装 Node.js 和 npm。
安装教程
```bash
克隆仓库
git clone https://github.com/yourusername/code-review-server.git
cd code-review-server
安装依赖
npm install
构建服务器
npm run build
```
配置
创建 .env
文件并配置 LLM 提供商和 API 密钥:
bash
cp .env.example .env
编辑 .env
文件:
```bash
LLM 提供商配置
LLM_PROVIDER=OPEN_AI
OPENAI_API_KEY=your_openai_api_key_here
```
调试方式
启动服务器:
bash
node build/index.js
使用 CLI 工具进行测试:
bash
node build/cli.js ./my-project --types .js,.ts --detail detailed --focus security,quality
开发模式
```bash
运行测试
npm test
开发模式
npm run watch
运行 MCP 检查工具
npm run inspector
```