Gh MCP Server

🚀 GitHub リポジトリ MCP サーバー

この Model Context Protocol (MCP) サーバーは、AI モデルが GitHub リポジトリの内容をコンテキストとしてアクセスできるようにします。AI の対話にコンテキストとして使用するために、ファイル内容、リポジトリ構造、およびリポジトリ全体を取得するツールを提供します。

✨ 主な機能

• リポジトリ全体の内容をコンテキストとして取得
• 特定のファイル内容をリポジトリから取得
• リポジトリ構造（ファイルリスト）を取得
• 拡張子でファイルをフィルタリング
• 特定のパスを除外
• 返されるファイル数を制限

📦 インストール

# リポジトリをクローン
git clone https://github.com/shanksxz/github-mcp.git
cd github-mcp

# 依存関係をインストール
npm install

# プロジェクトをビルド
npm run build

📚 ドキュメント

GitHub 認証の設定

サーバーは認証なしでパブリックリポジトリと共に使用できますが、認証されていない GitHub API リクエストには厳しいレート制限（1 時間あたり 60 回）があります。レート制限を 1 時間あたり 5000 回に引き上げるには、GITHUB_TOKEN 環境変数を設定してください。

# gh.sh という名前のファイルを作成し、以下の内容を追加します。
export GITHUB_TOKEN=your_github_personal_access_token
# ファイルに実行権限を付与する
chmod +x gh.sh
# ファイルを実行する
./gh.sh

個人用アクセストークンは GitHub Developer Settings で作成できます。

Cursor との連携

このサーバーを Cursor と一緒に使用するには、以下の手順に従ってください。

1. Cursor の設定を開く
2. 「MCP」を検索する
3. 「新しい MCP サーバーを追加」をクリックする
4. 以下の情報を入力します。
   • 名前：github-repo-context（または任意の名前）
   • タイプ：コマンド
   • コマンド：/path/to/your-local-repo-setup/gh.sh
5. 「保存」をクリックする
6. サーバー名の横にある切り替えスイッチをクリックして、サーバーを有効にする
7. これで、このプロジェクトでサーバーを使用できるはずです

サーバーは、MCP プロトコルに従って stdin/stdout を介して通信します。

利用可能なツール

サーバーは以下のツールを提供します。

1. get-repo-context：GitHub リポジトリ内のすべてのファイルをコンテキストとして取得します。

   • パラメータ：
     • owner：GitHub リポジトリの所有者/組織名
     • repo：GitHub リポジトリ名
     • maxFiles（オプション）：含める最大ファイル数（デフォルト：50）
     • fileExtensions（オプション）：含めるファイル拡張子（例：['js', 'ts', 'md']）
     • excludePaths（オプション）：除外するパス（デフォルト：['node_modules', 'dist', 'build']）

2. get-file-content：GitHub リポジトリ内の特定のファイルの内容を取得します。

   • パラメータ：
     • owner：GitHub リポジトリの所有者/組織名
     • repo：GitHub リポジトリ名
     • path：リポジトリ内のファイルパス

3. get-repo-structure：GitHub リポジトリの構造を取得します。

   • パラメータ：
     • owner：GitHub リポジトリの所有者/組織名
     • repo：GitHub リポジトリ名

💻 使用例

基本的な使用法

MCP に対応した AI モデルと組み合わせて使用する場合、次のようなコマンドを実行できます。

tensorflow/tensorflow リポジトリの構造を取得する

AI は get-repo-structure ツールを使用してリポジトリ構造を取得し、表示します。