Github PR Helper

🚀 GitHub拉取请求帮助工具

此工具旨在简化在AI编辑器中创建和管理GitHub拉取请求（PR）的流程，让你更高效地进行代码协作与管理。

🚀 快速开始

该工具借助GitHub CLI (gh) 处理身份验证，避免手动管理令牌，提供了模块化操作，能轻松创建新的拉取请求以及在现有拉取请求中添加评论。

✨ 主要特性

• 自动权限管理：使用GitHub CLI (gh) 处理身份验证，避免手动管理令牌。
• 模块化操作：提供两个核心功能：
  • create_pull_request：创建新的拉取请求。
  • add_pr_comment：在现有拉取请求中添加评论。

📦 安装指南

1. 安装GitHub CLI

在开始使用此工具之前，需先安装并配置GitHub CLI：

brew install gh  # 在Mac上安装
# 或者前往 https://github.com/cli/ 下载对应作业系统的安装包。

2. 登入GitHub CLI

使用以下命令登入你的GitHub帐户：

gh auth login

按照提示完成登录过程。

3. 配置AI编辑器

根据你使用的编辑器（例如Cursor、Windsurf等），将MCP服务添加到编辑器的设置中。具体步骤如下：

在Cursor中配置

1. 打开编辑器的设置界面。
2. 进入实验功能 > MCP服务设置。
3. 添加新的MCP服务，填写以下信息：

• 名称: github-pr-helper
• 类型: 命令
• 命令: /Users/yourusername/CascadeProjects/app-github-pr-helper/src/mcp-server.js

完成后保存设置并重新启动编辑器。

💻 使用示例

基础用法

1. 创建新的拉取请求

在AI编辑器中使用以下提示：

请使用 create_pull_request 工具创建GitHub拉取请求。
参数：
{
  "repoPath": "/path/to/your/repo",
  "title": "你的PR标题",
  "description": "你的PR描述，介绍这次提交的主要内容。",
  "ticketNumber": "例如：JIRA-123",
  "baseBranch": "基底分支名称，如main"
}

2. 添加评论到拉取请求

在AI编辑器中使用以下提示：

请使用 add_pr_comment 工具在PR添加评论。
参数：
{
  "repoPath": "/path/to/your/repo",
  "baseBranch": "基底分支名称，如main",
  "filePath": "要评论的文件路径，例如src/index.js",
  "lineNumber": 要评论的行号,
  "comment": "你的评论内容"
}

⚠️ 注意事项

⚠️ 重要提示

使用此工具前，请确保：

• 已使用 gh auth login 成功登入GitHub帐户。
• 在本地仓库中已创建并切换到要提交PR的分支。
• 已提交所有更改并推送到远程仓库。

💡 使用建议

此工具使用GitHub CLI来处理与GitHub相关的操作，无需手动管理令牌，极大地简化了权限管理流程。如果遇到任何问题，可以通过以下命令检查GitHub CLI的登录状态：

gh auth status

希望此工具能为你的GitHub工作流带来便利！