github-repo-mcp

by Ryan0204
Verified

Integrations

  • Enables browsing public GitHub repositories, navigating through directories, and viewing file contents with tools for listing repository files and fetching specific file data.

GitHub リポジトリ MCP

目次

✨ 主な機能

  • 💻 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

ウィンドウズNPX

cmd /c npx -y github-repo-mcp

.cursor/mcp.json 経由の Windows NPX

{ "mcpServers": { "github-repo-mcp": { "command": "wsl", "args": [ "bash", "-c", "cmd /c npx -y github-repo-mcp" ], "enabled": true } } }

Windows NPX は .cursor/mcp.json 経由で (パスが設定されていない場合)

# Find the full path to npx first which npx
{ "mcpServers": { "github-repo-mcp": { "command": "wsl", "args": [ "bash", "-c", "'/home/[username]/.nvm/versions/node/v20.18.0/bin/npx github-repo-mcp'" ], "enabled": true } } }

Smithery経由でインストール

Smithery経由で Claude Desktop 用の GitHub Repo MCP を自動的にインストールするには:

npx -y @smithery/cli install @Ryan0204/github-repo-mcp --client claude

反映されない場合は、数秒待つか、更新ボタンを数回クリックしてください。それでも反映されない場合は、正しいコマンドを入力したかどうかを確認してください。

ステップ2. 構成

GitHub Repo MCP サーバーは、GitHub API にアクセスするときに、より高いレート制限のために GitHub トークンを使用できます。

環境変数

変数必須デフォルト説明
GITHUB_TOKENいいえなしより高いレート制限のための GitHub 個人アクセス トークン

GitHub トークンの設定(オプション)

サーバーは認証なしで動作しますが、GitHub API には認証されていないリクエストに対するレート制限が大幅に低く設定されています。レート制限を上げるには、以下の手順を実行してください。

  1. https://github.com/settings/tokensで個人アクセストークンを作成します。
  2. mcp.json でトークンを環境変数として設定します。
{ "mcpServers": { "github-repo-mcp": { "command": "...", "args": [ ... ], "env": { "GITHUB_TOKEN": "Your_Github_Token" } "enabled": true, } } }

機能の概要

リポジトリ閲覧ツール

サーバーは、GitHub リポジトリと対話するための 3 つの主要なツールを提供します。

1. getRepoAllDirectories

GitHub リポジトリのルートにあるすべてのファイルとディレクトリを一覧表示します。

2. getRepoDirectories

GitHub リポジトリ内の特定のディレクトリの内容を一覧表示します。

  • パラメータ:
    • repoUrl : GitHubリポジトリのURL
    • path : 取得するディレクトリパス(例:"src")

3. getRepoFile

GitHub リポジトリから特定のファイルの内容を取得して表示します。

  • パラメータ:
    • repoUrl : GitHubリポジトリのURL
    • path : 取得するファイルパス(例: "src/index.js")

使用例

AI アシスタントでこれらのツールを使用する方法の例をいくつか示します。

  1. リポジトリ ルートの参照: AI アシスタントに「 https://github.com/Ryan0204/github-repo-mcpにあるリポジトリの内容を見せて」と依頼します。
  2. 特定のディレクトリの探索: 「 https://github.com/Ryan0204/github-repo-mcpの src ディレクトリにはどのようなファイルがありますか?」と質問します。
  3. ファイルの表示: 「 https://github.com/Ryan0204/github-repo-mcpの README.md ファイルを表示してください」と質問する

制限事項

  • レート制限:認証がない場合、GitHub API には厳しいレート制限(1 時間あたり 60 リクエスト)があります。
  • プライベートリポジトリ: 適切な権限を持つトークンが提供されない限り、パブリックリポジトリにのみアクセスできます。
  • バイナリファイル: サーバーは一般的なバイナリファイル拡張子を検出し、その内容を表示しません。
  • 大きなファイル: GitHub API では取得できるファイルのサイズに制限があります

トラブルシューティング

以下に一般的な問題とその解決策を示します。

  • レート制限を超えました: 設定セクションの説明に従ってGitHubトークンを設定してください
  • コマンドが見つかりません: パッケージがグローバルにインストールされていることを確認してください
  • 接続エラー: インターネット接続とGitHub APIのステータスを確認してください

問題が発生した場合は、出力でエラー メッセージを確認するか、GitHub リポジトリで問題を作成してください。


お楽しみください!☺️

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

GitHub Repo MCP は、AI アシスタントが GitHub リポジトリを参照し、ディレクトリを探索し、ファイルの内容を表示できるようにするオープンソースの MCP サーバーです。

  1. Table of contents
    1. ✨ Key features
      1. Getting Started
        1. Prerequisites
        2. Step 1. Installation
        3. Step 2. Configuration
      2. Feature Overview
        1. Repository Browsing Tools
        2. Usage Examples
        3. Limitations
      3. Troubleshooting
        ID: vrhwxwg4h4