Github Repository

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

GitHub Repo MCP はオープンソースの MCP サーバーで、あなたの人工知能アシスタントが GitHub リポジトリを閲覧し、ディレクトリを探索し、ファイル内容を表示できるようにします。

🚀 クイックスタート

目次

開始方法 • 機能概要

✨ 主な機能

• 💻 Cursor、Windsurf、Claude Desktop およびその他の stdio プロトコルをサポートする MCP クライアントと互換性があります。
• 🔎 任意のパブリック GitHub リポジトリの内容を調べることができます。
• 📂 リポジトリのディレクトリとサブディレクトリを閲覧できます。
• 📝 コードやテキストファイルの内容を表示できます。
• 📦 パッケージマネージャーを通じて簡単にインストールできます。

📦 インストール

前提条件

サーバーをシステムにインストールするには、以下が必要です。

• Node.js 18+
• npm または yarn

ステップ 1: インストール

Smithery、NPX を使用するか、IDE の mcp.json で設定することで、GitHub Repo MCP をインストールして実行できます。

MacOS

npx github-repo-mcp

Windows NPX

cmd /c npx -y github-repo-mcp

Windows NPX（mcp.json 設定）

{
  "mcp": {
    "servers": [
      {
        "name": "GitHub Repo MCP",
        "executable": "github-repo-mcp",
        "args": []
      }
    ]
  }
}

ステップ 2: 設定

config.json に以下の内容を追加します。

{
  "repositories": [
    {
      "url": "https://github.com/Ryan0204/github-repo-mcp",
      "name": "GitHub Repo MCP"
    }
  ]
}

📚 ドキュメント

機能概要

ツールとコマンド

1. listRepositories()

   • すべての設定済みリポジトリをリストします。

   listRepositories
   

2. getRepositoryContents(String url)

   • 指定された URL のリポジトリの内容を表示します。

   getRepositoryContents https://github.com/Ryan0204/github-repo-mcp
   

3. getDirectoryContents(String url, String path)

   • 指定されたパスのファイルとサブディレクトリを表示します。

   getDirectoryContents https://github.com/Ryan0204/github-repo-mcp src
   

4. getFileContents(String url, String path)

   • 指定された URL とパスのファイルの内容を表示します。

   getFileContents https://github.com/Ryan0204/github-repo-mcp README.md
   

問題解決

以下のような状況に遭遇した場合は、次の手順に従ってください。

• GitHub API に接続できない場合：

  • インターネット接続と GitHub の状態を確認してください。
  • コマンドを再実行してみてください。

  npm start
  

• ファイルまたはディレクトリが見つからない場合：

  • パスが正しいことを確認してください。
  • リポジトリのファイル構造を確認してください。

• レート制限を超えた場合：

  • GitHub アカウントを使用してトークンを取得してください。
  • config.json にトークンを追加してください。

以上の手順に従えば、GitHub Repo MCP サーバーをスムーズに使用できるはずです。その他の問題がある場合は、出力のエラーメッセージを確認するか、GitHub リポジトリで問題を作成してください。

楽しんでください！😊