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工作流帶來便利！