使用说明

项目简介

pr-review-agent 是一个友好的 GitHub PR 审查代理，旨在帮助开发者更高效地进行代码审查。它基于 Model Context Protocol (MCP) 服务器构建，可以集成到支持 MCP 协议的客户端，如 Cursor 编辑器。该代理能够自动分析 GitHub Pull Request (PR) 的代码变更，并生成审查意见，从而辅助开发者进行代码质量把控。

主要功能点

自动化 PR 审查: 能够根据配置的 Prompt 模板和项目上下文，自动审查 GitHub PR 的代码变更。
集成 Git 和 GitHub MCP 工具: 利用 Git 和 GitHub MCP 服务器提供的工具，获取代码仓库和 PR 的相关信息。
可定制的 Prompt 模板: 允许用户自定义 Prompt 模板（'prompt.md' 文件），以控制代码审查的侧重点和风格。
支持多种 MCP 客户端: 理论上支持所有兼容 MCP 协议的客户端，例如 Cursor, Claude Desktop, Goose 等。
生成审查意见并发布: 代理审查完成后，会将审查意见以评论的形式发布到 GitHub PR 上（需用户批准）。

安装步骤

克隆仓库: 首先将 'pr-review-agent' 仓库克隆到本地。

git clone https://github.com/Automattic/pr-review-agent.git
cd pr-review-agent

更新子模块: 初始化并更新 'mcp-servers' 子模块。

git submodule update --init --recursive

安装依赖: 安装 'mcp-servers' 目录下的依赖。

npm install --prefix mcp-servers

配置环境变量: 复制 '.env.example' 文件为 '.env'，并根据需要填写 GitHub Personal Access Token 等信息。
配置 Prompt 模板: 复制 'prompt.example' 文件为 'prompt.md'，并根据需要修改 Prompt 模板内容。

服务器配置

在支持 MCP 服务器配置的客户端（如 Cursor v0.45+）中，添加以下两个 MCP 服务器配置。注意将 '[PATH_TO_REVIEW_AGENT_FOLDER]' 替换为实际的 'pr-review-agent' 仓库的本地路径。

Git 服务器

{
  "name": "Git",
  "type": "Command",
  "command": "bash [PATH_TO_REVIEW_AGENT_FOLDER]/start-git.sh"
}

配置说明:

'name': 服务器名称，自定义，例如 "Git"。
'type': 服务器类型，选择 "Command" (命令)。
'command': 启动 Git MCP 服务器的命令，指向 'start-git.sh' 脚本。

GitHub 服务器
```
{
  "name": "GitHub",
  "type": "Command",
  "command": "bash [PATH_TO_REVIEW_AGENT_FOLDER]/start-github.sh"
}
```
配置说明:
- 'name': 服务器名称，自定义，例如 "GitHub"。
- 'type': 服务器类型，选择 "Command" (命令)。
- 'command': 启动 GitHub MCP 服务器的命令，指向 'start-github.sh' 脚本。
完成配置后，请在客户端中刷新 MCP 服务器列表，确认 Git 和 GitHub 服务器及其工具已成功加载。

基本使用方法

打开 MCP 客户端: 在配置了 MCP 服务器的客户端（如 Cursor）中打开编辑器。
选择 Agent 模式: 在客户端的编辑器中，选择使用 "Agent" 功能。
触发代码审查: 在编辑器中输入 '@@review' 命令，并粘贴需要审查的 GitHub PR 链接。
等待审查结果: 代理会自动调用 Git 和 GitHub MCP 工具获取 PR 信息，并根据 Prompt 模板生成审查意见。
批准并发布审查意见: 代理会将生成的审查意见展示给用户，用户确认后可以选择将其发布为 GitHub PR 的评论。

使用提示:

建议在项目仓库目录下使用该 Agent，以便为代理提供更丰富的项目上下文信息。
确保 '.env' 文件中配置了正确的 GitHub Personal Access Token 和 'PROJECT_REPOSITORY_PATH'。
可以根据项目需求修改 'prompt.md' 文件，定制审查 Prompt。

关键词