智能代码审查与修复助手

一个端到端的智能代码审查与修复助手参考实现,采用模型上下文协议(MCP)模式,利用检索增强生成(RAG)、Git集成和工具分析代码库并提出修复建议。

  • by kundansai25
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 kundansai25/smart-code-review-mcp

使用说明

智能代码审查与错误修复助手(MCP)

一个端到端的参考实现方案 智能代码审查与错误修复助手 该系统遵循模型上下文协议(MCP)模式,利用检索增强生成(RAG)、Git集成以及工具来分析代码库并提出修复方案。

特点/功能

  • FastAPI 后端提供 MCP 风格的端点
  • 使用本地分块+嵌入(抽象化)的RAG检索器(占位符)
  • 代码分析与修复建议工作流程
  • GitHub 集成用于获取代码、创建分支和打开拉取请求(使用 PyGithub)
  • Dockerfile 和 GitHub Actions CI
  • 用于与助手交互的前端示例存根(React)
  • 清晰的本地运行说明,并推送至您自己的Git仓库

注: 这个仓库包含模型/嵌入API的占位符。请替换 OPENAI_API_KEY 或在环境变量或GitHub密钥中设置其他提供商密钥。

快速入门(本地)

  1. 下载或创建此仓库后,对其进行克隆。
  2. 创建并激活一个Python虚拟环境:
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
  1. 设置环境变量:
export OPENAI_API_KEY="sk-..."
export GITHUB_TOKEN="ghp_..."
  1. 运行API:
uvicorn backend.main:app --reload --port 8000
  1. 使用前端(打开 frontend/README.md)或致电 /mcp/review 终端节点。

如何将文件上传到Git

  1. 在GitHub上创建一个新的空仓库。
  2. 在这个项目文件夹中:
git init
git add .
git commit -m "Initial commit - Smart Code Review MCP reference"
git branch -M main
git remote add origin https://github.com/<your-username>/<repo>.git
git push -u origin main

设置 GitHub Actions 密钥 OPENAI_API_KEY 和 GITHUB_TOKEN 在仓库设置中。

项目布局

  • backend/ - FastAPI服务 + 核心逻辑
  • frontend/ - React 代码占位符(单文件演示)
  • .github/workflows/ - CI(持续集成)工作流
  • Dockerfile, docker-compose.yml, requirements.txt - 部署与依赖项