使用说明
pr mcp服务器
MCP(模型上下文协议)服务器,用于使用AI自动创建Pull Request。分析Git分支,生成描述、标题,建议审阅者,并执行代码审阅。旨在加快审核速度,提高公关质量。
✨ 特性
- 🚀 统一的公关工作流程 -使用一个命令完成PR创建(“创建PR”)
- 🧠 AI驱动的代码审查 -将情境感知审查整合到公关描述中
- 🔍 项目背景分析 -检测TypeScript、i18n、状态管理、样式、测试框架
- 📝 公关生成 -生成PR描述(标准、详细、最小模板|EN/FR)
- 🏷️ 常规标题 -生成常规PR标题(壮举、修复、文档等)
- 🎨 智能GIF -根据工作类型自动添加相关GIF
- 👥 汽车评论家 -根据贡献历史推荐和添加审阅者
- 🔎 代码审查 -自动代码审查,并提供可操作的反馈
- 🤖 AI就绪 -与MCP检查器、游标和Claude Desktop配合使用
📚 文档
- 配置指南 -光标、克劳德桌面和MCP检查器的设置
- 工具参考 -所有可用工具的详细说明
- GitHub集成 -使用自动审阅器在GitHub上创建PR
- 聪明的评论者 -审阅者检测的工作原理和故障排除
- 智能GIF选择 -自动GIF选择和速率限制处理
- 例子 -实际使用示例
- 建筑 -项目结构与设计
🚀 快速开始
需求
- Node.js 18+
- Git仓库
安装
地方发展:
npm install
npm run build
全局安装(推荐):
npm link
这使 pr-mcp-server 全球可用的命令。
使用MCP检查员进行测试
之后 npm link,运行:
npx @modelcontextprotocol/inspector pr-mcp-server
检查员将列出所有可用的工具。在Git存储库中运行它以获得完整功能。
与光标一起使用
添加到 ~/.cursor/mcp.json:
{
"mcpServers": {
"pr-mcp-server": {
"command": "pr-mcp-server",
"cwd": "{workspaceFolder}"
}
}
}
重新启动Cursor,然后询问:
- “创建PR” -使用统一的工作流程(推荐)
- “生成我的PR标题”
- “分析我的分支并生成PR描述”
- “使用评论员在GitHub上创建公关”
看 配置指南 了解更多详情。
🎯 统一的公关创建工作流程(人工智能驱动)
当你说 **“创建PR”**Claude(人工智能)精心策划了一个智能工作流程:
运作原理
-
呼叫
review工具 -收集全面的项目背景:- 检测语言/框架(TypeScript、PHP、Python、Go、Rust等)
- 识别技术(i18n、状态管理、样式、测试)
- 提取完整的差异和提交历史记录
- 返回包含所有上下文的结构化提示
-
Claude分析并生成评论 -真正的人工智能分析:
- 自动理解项目惯例
- 识别您的技术栈特有的问题
- 提供智能、情境感知的建议
- 适用于任何语言/框架(不仅仅是TypeScript!)
-
呼叫
create_pr_complete有评论 -创建完整的PR:- 生成常规提交样式标题
- 创建全面的描述
- 包括克劳德的智能评论
- 根据PR类型添加智能GIF
- 创建/更新GitHub PR
- 从Git历史记录中分配审阅者
是什么让它变得智能
与基于规则的工具不同,它使用 克劳德的智力 致:
- ✅ 适应任何项目(PHP Laravel、Python Django、Go、Rust等)
- ✅ 理解复杂的模式和上下文
- ✅ 提供针对具体项目的建议
- ✅ 检测违反项目约定的行为
示例:在PHP Laravel项目中,它将标记SQL注入漏洞并建议Eloquent ORM。在React i18n项目中,其将捕获硬编码字符串。全部自动!
示例用法
# In Cursor or Claude Desktop, simply say:
"Create a PR"
# Claude will automatically:
# 1. Call 'review' to get project context
# 2. Analyze the context and generate intelligent review
# 3. Call 'create_pr_complete' with the review
# 4. Return the PR URL
# With specific options:
"Create a PR in English with the detailed template"
"Create a draft PR without reviewers"
看 AI_POWERED_REVIEW.md 了解人工智能审查工作原理的技术细节。
🛠️ 可用工具
| 工具 | 说明 | 推荐 |
|---|---|---|
create_pr_complete |
🚀 统一工作流程 -通过人工智能审核完成公关创建 | ⭐ 是 |
create_pr |
在GitHub上使用自动审阅器创建PR(无AI审阅) | |
analyze_branch |
分析分支之间的差异 | |
generate_pr_title |
生成常规PR标题 | |
generate_pr_description |
生成PR描述 | |
generate_pr_complete |
生成标题和描述 | |
suggest_reviewers |
根据Git历史记录推荐审阅者 | |
review |
自动代码审查(上下文感知) |
推荐:使用 create_pr_complete 为了获得最佳体验。它将所有功能与智能、上下文感知的代码审查相结合。
看 工具参考 详细文档。
📦 有用的脚本
npm run build # Compile TypeScript to dist/
npm start # Start the MCP server
npm test # Run tests
npm run test:watch # Run tests in watch mode
npm run test:ui # Run tests with UI
npm run dev # Run in development mode
🐛 故障排除
- “不是git存储库”:在Git仓库中运行服务器
- ESM进口问题:使用Node 18+构建项目(
npm run build) - 权限错误:确保你的shell可以访问仓库
- “需要GitHub令牌”:设置
GITHUB_TOKEN环境变量 - “远程上不存在分支”:先推你的树枝
看 GitHub集成 以进行更多故障排除。
📄 许可证
麻省理工学院
