Github Pr MCP Server

🚀 GitHub PR ロボット管理サーバー（GitHub PR Management Server）

このサーバーは、GitHubのPull Requestを管理するためのツールです。様々な操作を自動化し、Pull Requestの管理を効率化します。

🚀 クイックスタート

📦 インストール

前提条件

• 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

✨ 主な機能

核心機能

1. Pull Requestの作成
   • コードハイライト、テストレポートなどの基本機能と拡張機能を提供します。
2. Pull Requestの管理
   • Pull Requestの一覧表示、更新、および閉じる操作を行います。

利用可能なツール

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[];// 新しいラベル（オプション）
}

🔧 開発ガイド

プロジェクトのクローン

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. サーバーが起動しない場合
   • 設定ファイルが正しいことを確認してください。
   • トークンに正しい権限が付与されていることを確認してください。
2. Pull Requestを作成できない場合
   • リポジトリへのアクセス権限を確認してください。
   • ブランチとベースブランチが存在することを確認してください。

🤝 コントリビューションガイド

コードの提出

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