GitHub PR Helper

GitHub PR Helper

This is a GitHub Pull Request creation tool MCP Service, using GitHub CLI (gh) command-line tool to create PRs and conduct code reviews, eliminating the need to manually handle permission issues.

功能

This service provides the following features:

• Creating GitHub Pull Requests: Automatically creates GitHub PRs based on the provided title, description, ticket number, and target branch. The PR title will consist of "Title [Ticket Number]", and the PR description will consist of the PR title and description.
• Code Review: Adds comments to PRs, facilitating code review.

前置條件

• Install GitHub CLI:
  • macOS: brew install gh
  • Windows: winget install --id GitHub.cli
  • Linux: Refer to the official GitHub CLI documentation
• Login GitHub CLI:

  gh auth login
  

  Follow the prompts to complete the login process. This will automatically handle authentication without manually managing tokens.

安裝與設定

1. Install dependencies:

   npm install
   

2. Configure environment variables (optional): Set the following variables in the .env file:
   • PORT: Server port (default is 3000)

使用方式

HTTP 服務

開發模式

npm run dev

生產模式

npm start

MCP 服務

npm run mcp

API 端點

HTTP API

• POST /api/github/pr: Create GitHub Pull Request
  • Request Body:

    {
      "repoPath": "本地 Git 倉庫路徑",
      "title": "PR 標題",
      "description": "PR 描述",
      "ticketNumber": "票號",
      "baseBranch": "目標分支"
    }

    Copy

• POST /api/github/pr/comment: Add comment to PR
  • Request Body:

    {
      "repoPath": "本地 Git 倉庫路徑",
      "baseBranch": "比較的基準分支",
      "filePath": "文件路徑",
      "lineNumber": 10,
      "comment": "評論內容"
    }

    Copy

MCP 工具

• create_pull_request: Create GitHub Pull Request
  • Parameters:
    • repoPath: Local Git repository path
    • title: PR title
    • description: PR description
    • ticketNumber: Ticket number
    • baseBranch: Target branch
• add_pr_comment: Add comment to PR
  • Parameters:
    • repoPath: Local Git repository path
    • baseBranch: Comparison base branch
    • filePath: File path
    • lineNumber: Line number
    • comment: Comment content

安裝到 AI 助手

安裝到 Roo Code (VSCode)

1. Ensure that the Roo Code extension is installed and configured.
2. Locate the MCP settings file for Roo Code:

   /Users/aaron/Library/Application Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json
   

3. Edit the file, adding the following configuration to the mcpServers object:

   "github-pr-helper": {
     "command": "node",
     "args": ["/Users/aaron/CascadeProjects/app-github-pr-helper/src/mcp-server.js"],
     "disabled": false,
     "alwaysAllow": []
   }

   Copy

4. Save the file and restart VSCode.
5. In Roo Code, you should now be able to use the create_pull_request and add_pr_comment tools.

安裝到 Claude (Anthropic)

1. Locate the Claude settings file:

   /Users/aaron/Library/Application Support/Claude/claude_desktop_config.json
   

2. Edit the file, adding the following configuration to the mcpServers object:

   "github-pr-helper": {
     "command": "node",
     "args": ["/Users/aaron/CascadeProjects/app-github-pr-helper/src/mcp-server.js"],
     "disabled": false,
     "alwaysAllow": []
   }

   Copy

3. Save the file and restart the Claude application.
4. In Claude, you should now be able to use the create_pull_request and add_pr_comment tools.

安裝到 Windsurf

1. Locate the Winsurf settings file, typically located at:

   /Users/aaron/Library/Application Support/Winsurf/winsurf_config.json
   

   If you cannot find this file, try searching:

   find ~/Library/Application\ Support -name "*winsurf*" -type f
   

2. Edit the file, adding the following configuration to the mcpServers object:

   "github-pr-helper": {
     "command": "node",
     "args": ["/Users/aaron/CascadeProjects/app-github-pr-helper/src/mcp-server.js"],
     "disabled": false,
     "alwaysAllow": []
   }

   Copy

3. If the mcpServers object does not exist, you will need to create it:

   {
     "mcpServers": {
       "github-pr-helper": {
         "command": "node",
         "args": ["/Users/aaron/CascadeProjects/app-github-pr-helper/src/mcp-server.js"],
         "disabled": false,
         "alwaysAllow": []
       }
     }
   }

   Copy

4. Save the file and restart Winsurf.
5. In Winsurf, you should now be able to use the create_pull_request and add_pr_comment tools.

安裝到 Cursor

方法一：通過 GUI 設定（推薦）

1. 在 Cursor 中，打開設定頁面。
2. 找到 MCP 服務設定區域，點擊添加新服務。
3. 填寫以下欄位：
   • Name: github-pr-helper（服務名稱）
   • Type: command（選擇命令類型）
   • Command: node /Users/aaron/CascadeProjects/app-github-pr-helper/src/mcp-server.js（MCP 服務路徑）
4. 儲存設定後，重新啟動 Cursor。
5. 在 Cursor 中，你現在應該可以使用 create_pull_request 和 add_pr_comment 工具。

方法二：通過編輯設定檔案

1. 找到 Cursor 的設定檔案：

   /Users/aaron/Library/Application Support/Cursor/User/settings.json
   

2. 編輯該檔案，添加或修改 cursor.experimental.mcp.servers 設定：

   "cursor.experimental.mcp.servers": {
     "github-pr-helper": {
       "command": "node",
       "args": ["/Users/aaron/CascadeProjects/app-github-pr-helper/src/mcp-server.js"],
       "disabled": false,
       "alwaysAllow": []
     }
   }

   Copy

3. 儲存檔案後，重新啟動 Cursor。
4. 在 Cursor 中，你現在應該可以使用 create_pull_request 和 add_pr_comment 工具。

使用範例

在 AI 助手中，你可以使用以下提示來創建 GitHub PR：

請使用 create_pull_request 工具創建 GitHub Pull Request。
參數：
{
  "repoPath": "/path/to/your/repo",
  "title": "實現新功能",
  "description": "這個 PR 實現了新功能，包括...",
  "ticketNumber": "JIRA-123",
  "baseBranch": "main"
}

你也可以使用以下提示在 PR 添加評論：

請使用 add_pr_comment 工具在 PR 添加評論。
參數：
{
  "repoPath": "/path/to/your/repo",
  "baseBranch": "main",
  "filePath": "src/index.js",
  "lineNumber": 42,
  "comment": "這裡可以使用更簡潔的寫法"
}

注意事項

1. 使用此工具前，請確保你已經：
   • 使用 gh auth login 登入 GitHub CLI
   • 在本地 Git 倉庫中創建並切換到了你想要提交 PR 的分支
   • 已經提交了所有更改
   • 已經將分支推送到遠程倉庫
2. 此工具使用 GitHub CLI (gh) 來處理 GitHub 相關操作，無需手動管理 token，大大簡化了權限管理。
3. 如果遇到權限問題，請確保你已經正確登入 GitHub CLI，可以通過以下命令檢查登入狀態：

   gh auth status