Github Pr MCP Server

🚀 GitHub PR 機器人管理服務器

GitHub PR 機器人管理服務器可幫助用戶高效地創建、管理 Pull Request，提供基礎和增強功能，提升開發協作效率。

🚀 快速開始

在使用 GitHub PR 機器人管理服務器之前，你需要完成安裝和配置。

📦 安裝指南

前提條件

• Node.js 18+
• npm 或 yarn
• Git
• GitHub 賬戶及個人訪問令牌

全局安裝

npm install -g github-pr-mcp

啟動服務器

github-pr-mcp start

💻 使用示例

基礎用法

配置文件示例

// config.json
{
  "servers": [
    {
      "name": "github",
      "type": "github",
      "token": "your_github_token"
    },
    {
      "name": "github-pr",
      "type": "github-pr",
      "token": "your_github_token",
      "enhancedFeatures": true
    }
  ]
}

啟動服務器（指定配置文件）

github-pr-mcp start --config config.json

高級用法

create_pull_request

創建帶增強功能的 Pull Request：

{
  // 必填字段（兼容基礎功能）
  owner: string;        // 所有者
  repo: string;         // 倉庫名稱
  title: string;        // 標題
  head: string;         // 分支名（例如：feature-branch）
  base: string;         // 基礎分支（例如：main）

  // 可選字段（兼容基礎功能）
  body?: string;        // 描述
  draft?: boolean;      // 是否為草稿
  maintainer_can_modify?: boolean; // 維護者是否可以修改

  // 增強功能字段
  overview?: string;    // 概要
  keyChanges?: string[];// 關鍵變更點
  codeHighlights?: string[];// 代碼高亮部分
  testing?: string[];// 測試報告
  links?: Array<{ title: string; url: string }>; // 鏈接列表
  additionalNotes?: string; // 補充說明
  issueIds?: string[];// 關聯的Issue ID
  checklist?: {
    adhereToConventions?: boolean; // 是否符合規範
    testsIncluded?: boolean;        // 是否包含測試
    documentationUpdated?: boolean;  // 文檔是否更新
    changesVerified?: boolean;       // 變更是否驗證
    screenshotsAttached?: boolean;   // 截圖是否上傳
  };
  attachments?: Array<{
    type: "image" | "video" | "diagram"; // 類型
    alt: string;                         // 替代文本
    url: string;                          // 鏈接
    width?: number;                      // 寬度（可選）
  }>;
  labels?: string[];// 標籤
  reviewers?: string[];// 審查人
  assignees?: string[];// 負責人
}

list_pull_requests

列出倉庫中的 Pull Request：

{
  owner: string; // 所有者
  repo: string;  // 倉庫名稱
}

update_pull_request

更新 Pull Request：

{
  owner: string;         // 所有者
  repo: string;          // 倉庫名稱
  pullRequestId: number; // Pull Request ID
  title?: string;        // 新標題（可選）
  body?: string;         // 新描述（可選）
  labels?: string[];// 新標籤（可選）
}

✨ 主要特性

核心功能

1. 創建 Pull Request
   • 提供基礎和增強功能，包括代碼高亮、測試報告等。
2. 管理 Pull Request
   • 列出、更新及關閉 Pull Request。

可用工具

提供了 create_pull_request、list_pull_requests、update_pull_request 等工具，滿足不同場景下的 Pull Request 操作需求。

📚 詳細文檔

開發指南

克隆項目

git clone https://github.com/yourusername/github-pr-mcp.git
cd github-pr-mcp

安裝依賴

npm install

啟動開發服務器

npm run dev

打包構建

npm run build

測試指南

單元測試

npm test

集成測試

npm run integration-test

貢獻指南

提交代碼

1. 創建功能分支：git checkout -b feature/your-feature
2. 提交更改：git commit -m "feat: 添加新功能"
3. 推送到遠程倉庫：git push origin feature/your-feature

提交 Pull Request

• 在GitHub倉庫中提交Pull Request。
• 包含詳細的變更說明。

項目結構

github-pr-mcp/
├── src/                 # 源代碼目錄
│   ├── server.js        # 主服務器文件
│   └── config.js       # 配置管理
├── package.json         # 依賴管理
└── README.md            # 項目文檔

📄 許可證

本項目採用 MIT License。

📞 聯繫方式

• GitHub Issues
• 郵箱：contact@github-pr-mcp.com