代码审查MCP工具
此工具是一个模型上下文协议（MCP）服务器，它提供自动代码审查，并为支持MCP集成的任何应用程序留下GitHub PR注释。
特性
- 比较两个git分支之间的代码差异
- 比较GitHub拉取请求URL的代码差异
- 在GitHub pull请求中添加摘要注释
- 在GitHub pull请求中添加特定行的注释
- 提供详细的代码审查指南
- 支持Notion集成，从Notion代码块中检索审查指南，默认指南作为回退
- 支持本地markdown文件以获得完整的审核说明
- 包括预先配置的样式和代码审查指南
- 从本地目录读取PR模板
- 创建GitHub Pull请求，自动检测存储库信息
- 无需查看说明即可获取原始git diff输出
工具
- 定时检查：在分支和基分支之间运行git diff。返回差异以及查看和修复问题的说明。
- GetLocalGitDiff：在本地获取两个分支之间的git diff。返回原始差异输出，不含审阅说明。
- 使用GithubUrl进行代码审查：从GitHub PR URL获取差异。返回差异以及查看和修复问题的说明。
- AddPR摘要评论：向GitHub PR添加摘要注释。
- 添加：为GitHub PR中的特定行添加多个注释。支持在PR diff中对特定更改的行进行注释。
- Getpr模板：从指定的文件夹路径和模板名称中读取PR模板，如果找不到，则返回模板内容或默认模板。
- 创建PR：使用指定的标题、正文和分支创建新的GitHub Pull Request。从本地git配置中自动检测GitHub URL和当前分支。
建筑
- MCP服务器：监听来自任何MCP兼容客户端应用程序的代码审查请求。
- Git集成：使用本地git或GitHub PR生成差异。
- 概念整合：如果已配置，则从Notion代码块中获取审查指南。
- 本地文件支持：从本地markdown文件中读取完整的审核说明。
- 自动审核：分析代码差异并生成审阅意见和建议。
先决条件
- Node.js（建议使用v18或更高版本）
- Git已安装在您的系统上
- 对于GitHub PR审核，您必须提供以下任一信息：
- 一 GITHUB_TOKEN 环境变量（使用GitHub RESTful API）， 或 - 拥有GitHub CLI(gh)已安装并验证
- （可选）用于指南集成的通知API令牌
MCP配置
要在任何支持MCP的应用程序中使用此工具，请执行以下步骤：
- 打开MCP支持的应用程序的配置文件。
- 添加以下配置：
{
"mcpServers": {
"code-review-tool": {
"command": "npx",
"args": ["-y", "code-review-mcp-server"],
"env": {
"GITHUB_TOKEN": "github_token",
"NOTION_API_KEY": "notion_api_key",
"NOTION_CODE_REVIEW_GUIDELINE_CODE_BLOCK_URL": "notion_code_block_url_here",
"NOTION_STYLE_GUIDELINE_CODE_BLOCK_URL": "notion_code_block_url_here",
"LOCAL_INSTRUCTIONS_FILE_PATH": "/path/to/complete-instructions.md",
"IGNORE_PATTERNS": "pattern1,pattern2,pattern3"
}
}
}
}环境变量描述
Variable Required Description
GITHUB_TOKEN Optional GitHub personal access token for API access. Falls back to GitHub CLI if not provided.
LOCAL_INSTRUCTIONS_FILE_PATH Optional Path to a local markdown file containing complete review instructions. When provided, this file completely replaces the combined Notion/default guidelines. Priority: Local > Notion > Default.
IGNORE_PATTERNS Optional Comma-separated glob patterns for files to exclude from review.
Notion
NOTION_API_KEY Optional Required for fetching review guidelines from Notion.
NOTION_CODE_REVIEW_GUIDELINE_CODE_BLOCK_URL Optional Notion URL containing code review guidelines. Must point to a Notion </> Code block and requires valid NOTION_API_KEY to function. Falls back to default guidelines if not configured.
NOTION_STYLE_GUIDELINE_CODE_BLOCK_URL Optional Notion URL containing style guidelines. Must point to a Notion </> Code block and requires valid NOTION_API_KEY to function. Falls back to default guidelines if not configured.
审查指令优先级
该工具支持多种来源的审查说明，优先级顺序如下(实施):
- 本地Markdown文件 （最高优先级）
- 通过设置 LOCAL_INSTRUCTIONS_FILE_PATH 环境变量 - 必须是a .md 或 .markdown 文件 - 完全替换所有其他可用的指令源 - 如果无法读取文件，则回退到Notion/Default
- 概念整合 （中等优先级）
- 结合了Notion的样式指南和代码审查指南 - 需要 NOTION_API_KEY 以及相应的URL环境变量
- 默认指南 （最低优先级）
- 内置风格指南和代码审查指南 - 始终可用作后备
概念集成设置
1.请求通知API令牌
- 访问 概念开发者
- 创建新的集成
- 获取API令牌
有关详细说明，请参阅： 通知API授权指南
2.配置环境变量
该工具需要以下环境变量：
NOTION_API_KEY=your_token_here
NOTION_CODE_REVIEW_GUIDELINE_CODE_BLOCK_URL=your_notion_code_block_url
NOTION_STYLE_GUIDELINE_CODE_BLOCK_URL=your_notion_style_guideline_url这些可以在 env MCP配置的一部分，如上所示。
3.将集成添加到Notion页面
- 点击
ShareNotion页面上的按钮 - 将您的集成添加到页面的共享列表中
注意：目前仅支持从Notion读取代码块
有关详细说明，请参阅： 通知API连接指南
用法
小贴士：为了获得更好的审查结果，建议在运行代码审查命令之前切换到正在审查的分支。
本地Git分支审核
在您的MCP兼容应用程序中，发送以下命令：
code review
base branch: branch/any_branch这将：
- 比较当前分支和指定基本分支之间的差异
- 自动生成git diff
- 根据样式和代码审查指南进行审查
- 提供详细的评审结果和改进建议
获取原始Git差异
要只获取git diff而不查看说明：
get local git diff
base branch: main这将返回当前分支和指定基分支之间的原始git diff输出，可用于进一步处理或分析。
GitHub公关评论
在您的MCP兼容应用程序中，发送以下命令：
code review
https://github.com/owner/repo/pull/123
After generating the review report, please:
1. Add PR summary comment
2. If individual files require suggested changes, use line comments.这将获取PR的差异，提供代码审查，并直接在GitHub上留下PR注释。
创建GitHub Pull请求
创建具有自动存储库检测功能的PR：
create PR base on diff
base branch: main该工具将：
- 从git remote自动检测GitHub存储库URL
- 将当前分支用作源分支
- 验证当前分支是否已推送到远程
- 使用GitHub CLI或REST API创建PR
- 支持创建PR草案和分配里程碑
手动 （如果自动检测失败）：
create PR
github url: https://github.com/user/repo
base branch: main读取PR模板
从您的存储库中读取PR模板：
get PR template这将：
- 搜索
pull_request_template.md在指定文件夹中 - 还要检查
.github/子目录 - 返回模板内容或默认模板（如果未找到）
自定义模板名称:
get PR template
folder path: /path/to/your/repo/template
template name: custom_template.md用于自动代码审查的CI集成
您可以通过触发n8n webhook来自动化CI管道中的代码审查，该webhook将调用此项目的MCP工具来执行审查并返回结果或在PR上留下评论。
有关分步指南和推荐的工作流程图，请参阅： CI与n8n和MCP工具的集成
审查指南
此工具提供了多种配置审核指南的方法：
1.本地Markdown说明（推荐）
以markdown格式创建一个完整的指令文件，并设置 LOCAL_INSTRUCTIONS_FILE_PATH 环境变量。这为您的审核过程提供了最大的灵活性和版本控制。
2.概念整合
通过Notion代码块配置单独的样式和代码审查指南。
3.默认指南
该工具包括内置指南，涵盖：
- 风格指南：变量命名、函数命名、常量命名等的代码样式标准。
- 代码审查指南：基于SOLID原则、可读性、不变性等的代码质量标准。
