Github PR Helper

🚀 GitHub プルリクエストヘルパーツール

このツールは、AIエディタでのGitHubプルリクエスト（PR）の作成と管理のプロセスを簡素化することを目的としています。GitHub CLI (gh) を使用して自動的に権限管理を行い、手動でのトークン管理を避けることができます。また、新しいプルリクエストの作成や既存のプルリクエストへのコメント追加など、様々な操作を容易に行うことができます。

✨ 主な機能

• 自動権限管理：GitHub CLI (gh) を使用して認証を処理し、手動でのトークン管理を避けます。
• モジュール化操作：2つの主要な機能を提供します。
  • 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

設定を保存し、エディタを再起動してください。

💻 使用例

基本的な使用法

新しいプルリクエストの作成

AIエディタで以下のプロンプトを使用してください。

create_pull_request ツールを使用してGitHubプルリクエストを作成してください。
パラメータ:
{
  "repoPath": "/path/to/your/repo",
  "title": "あなたのPRのタイトル",
  "description": "あなたのPRの説明。このコミットの主な内容を記載してください。",
  "ticketNumber": "例: JIRA-123",
  "baseBranch": "ベースブランチ名、例: main"
}

既存のプルリクエストへのコメント追加

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ワークフローをより便利にすることを願っています！