Github Explorer MCP

🚀 GitHub 探索器 MCP サーバー

このMCP（ミドルウェアプロトコル）サーバーは、Claude DesktopやCursorなどのクライアントが使用するために、GitHubリポジトリの情報（ファイル内容、ディレクトリ構造、その他のメタデータを含む）を提供します。

✨ 主な機能

• リポジトリ概要：GitHubリポジトリの包括的な情報を取得します。
• ディレクトリ構造：任意のリポジトリの完全なファイル構造を確認し、ASCIIツリー形式で表示します。
• ファイル内容：特定のファイルの内容にアクセスします。
• メタデータ強化：スター数、フォーク数、説明、最終更新日などの情報を取得します。
• ローカルリポジトリクローン：より高速な処理とより完全なデータのために、リポジトリをローカルにクローンします。
• キャッシュシステム：API呼び出し回数を減らすために、リポジトリデータを効率的にキャッシュします。
• 進捗通知：長時間の操作の更新状態を通知します。
• 形式オプション：テキストまたは構造化されたJSON形式でデータを取得します。
• 自動補完：リポジトリの所有者と名前の提案を提供します。
• Webインターフェース：HTTPモードで実行すると、基本的なステータスページと情報を提供します。

📦 インストール

NPMを使用する場合

# npmからインストール
npm install @trishchuk/github-explorer-mcp -g

# サーバーを実行（MCPクライアントのstdioモード）
github-explorer-mcp

# またはHTTP/SSEモードで実行
github-explorer-mcp-sse

Dockerを使用する場合

# Dockerイメージをビルド
docker build -t github-explorer-mcp .

# コンテナを実行
docker run -p 3000:3000 github-explorer-mcp

💻 使用例

Claude Desktopとの連携

Claude Desktopの設定に以下を追加します。

{
  "mcpServers": {
    "github-explorer": {
      "command": "npx",
      "args": ["-y", "@trishchuk/github-explorer-mcp"]
    }
  }
}

Cursorとの連携

Cursorの設定に以下を追加します。

{
  "mcpServers": {
    "github-explorer": {
      "command": "npx",
      "args": ["-y", "@trishchuk/github-explorer-mcp"]
    }
  }
}

📚 ドキュメント

API リファレンス

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

github_repository_summary

GitHubリポジトリの概要情報を取得します。

{
  owner: string;    // GitHub組織またはユーザー名
  repo: string;     // リポジトリ名
  branch?: string;  // オプションのブランチ名
  includeMetadata?: boolean; // スター数、フォーク数などのメタデータを含めるかどうか
}

github_directory_structure

GitHubリポジトリのディレクトリ構造を取得します。

{
  owner: string;    // GitHub組織またはユーザー名
  repo: string;     // リポジトリ名
  branch?: string;  // オプションのブランチ名
}

github_file_content

GitHubリポジトリ内のファイルの内容を取得します。

{
  owner: string;    // GitHub組織またはユーザー名
  repo: string;     // リポジトリ名
  file_path: string; // ファイルパス
  branch?: string;  // オプションのブランチ名
}

🔧 技術詳細

開発手順

リポジトリのクローン

以下のコマンドを使用してプロジェクトをクローンします。

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

依存関係のインストール

プロジェクトに必要な依存関係をインストールします。

npm install

実行

プロジェクトを実行します。

npm start

トラブルシューティング

Node.js バージョンの問題

Node.js 18以上のバージョンを使用していることを確認してください。問題が発生した場合は、Node.jsを確認してアップグレードしてください。

Docker デプロイの問題

Dockerでのデプロイで問題が発生した場合は、イメージが正しくビルドされていること、およびコンテナの設定が正しいことを確認してください。

📄 ライセンス

このプロジェクトへの改善を支援するため、Pull Requestの送信を歓迎します！