使用说明
代码审查mcp
MCP服务器 AI驱动的代码审查 使用 文学硕士 以及与OpenAI兼容的LLM代理。从Cursor(或任何MCP客户端)使用它来查看工作区中的文件并获取内联建议。
目的
此回购提供了 模型上下文协议(MCP) 服务器:
- 查看代码文件 通过LLM(通过您的代理)和 写内联评论 包括建议、错误提示、安全/性能说明和样式改进。
- 列出工作区文件 这样客户就可以发现要查看的内容。
服务器在容器中运行(或在本地使用UV),将项目挂载为工作区,并公开两个工具: review_code_file 和 list_workspace_files它被设计为与Cursor的MCP集成以及作为与OpenAI兼容的API公开的任何LLM后端(例如LiteLLM代理、OpenAI、Azure等)一起工作。
将其用作MCP(例如在游标中)
1.配置环境
复制示例env并设置LLM代理和项目路径:
cp env.example .env
# Edit .env: LLM_BASE_URL, LLM_API_KEY, LLM_MODEL, PROJECT_DIR
所需变量:
| 变量 | 描述 |
|---|---|
LLM_BASE_URL |
OpenAI兼容的代理基础URL(例如。 https://your-proxy.example.com/v1) |
LLM_API_KEY |
代理的API密钥 |
LLM_MODEL |
型号名称(例如。 gpt-4, claude-3-sonnet,或您的代理的型号id) |
PROJECT_DIR |
要查看的项目的绝对路径(用于Docker挂载) |
2.构建Docker镜像
./setup.sh
# or: docker compose build
3.将服务器添加到Cursor的MCP配置中
在光标中: 设置→ MCP (或编辑MCP配置文件,例如。 ~/.cursor/mcp.json 或项目级配置)。添加这样的服务器条目,用您自己的占位符值替换占位符值:
{
"mcpServers": {
"code-review": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e", "LLM_BASE_URL=https://your-llm-proxy.example.com",
"-e", "LLM_API_KEY=your_llm_proxy_api_key_here",
"-e", "LLM_MODEL=gpt-4",
"-v", "/absolute/path/to/your/project:/workspace:rw",
"code-review-mcp:latest"
],
"description": "AI-powered code review via LLM proxy",
"disabled": false
}
}
}
重要提示:
-v /path/to/your/project:/workspace:rw必须指向您要查看的回购;服务器在以下位置读取和写入文件/workspace.LLM_*env变量args覆盖任何违约;使用与您的.env(或者如果将图像默认值烘焙到图像中,则省略并依赖它们)。
保存后,Cursor将列出 代码审查 MCP服务器及其工具。然后,您可以要求AI“审查” src/main.py“or”列出文件 src”;它将呼叫 review_code_file 和 list_workspace_files 根据需要。
4.(可选)不使用Docker运行(本地)
安装 紫外线 并直接运行服务器:
uv sync
export LLM_BASE_URL=... LLM_API_KEY=... LLM_MODEL=...
export WORKSPACE_DIR=/path/to/your/project # or PROJECT_DIR for consistency with .env
uv run python src/server.py
对于Cursor,您可以将MCP指向此过程(例如,通过设置env并运行的包装器脚本 uv run python src/server.py)而不是 docker run 上面的命令。
MCP工具
| 工具 | 说明 |
|---|---|
| review_code_file | 查看工作区中的文件,并添加带有建议和改进的内联注释。选项: file_path (必填), review_depth (quick / standard / thorough), focus_areas (例如。 "security, performance"). |
| list_workspace_files | 列出工作区(或子目录)下的文件。选项: directory (默认值 ".").忽略 .git, node_modules, __pycache__, .venv, venv. |
设置参考
- 环境: 看
env.example对于所有变量。永远不要泄露真正的秘密;使用.env(gitignored)或env变量。 - Docker:
./setup.sh检查Docker/Compose,创建.env如果需要,并构建code-review-mcp:latest那么docker compose up运行服务器(stdio MCP)。 - 本地开发人员:
uv sync && uv run python src/server.py(确保LLM_*和WORKSPACE_DIR已设置)。
有关游标MCP的更多信息,请参阅 光标MCP文档.
