MCP Github Reader Prod

🚀 MCP GitHub リーダー

この軽量なモデルコンテキストプロトコル（MCP）サーバーは、GitHubリポジトリを大規模言語モデルのコンテキストに取り込むために設計されています。

✨ 主な機能

• APIベース：ローカルでリポジトリをクローンする必要はなく、直接GitHub APIとやり取りできます。
• リポジトリ分析：任意のGitHubリポジトリの概要と統計情報を取得できます。
• ファイルアクセス：単一のファイル内容や、リポジトリ全体のファイル構造を取得できます。
• スマートフィルタリング：ワイルドカードや正規表現を使って、ファイルの包含または除外を行えます。
• キャッシュサポート：GitHub APIの制限を回避するため、スマートキャッシュと最適化されたリクエストパターンをサポートしています。
• 検索機能：特定のパターンに一致するファイルを検索できます。
• MCP互換性：モデルコンテキストプロトコルをサポートするすべてのLLMクライアントと互換性があります。
• プロンプトテンプレート：一般的なリポジトリ分析タスクに使用できるプロンプトテンプレートが用意されています。

📦 インストール

グローバルインストール（CLI使用を推奨）

npm install -g mcp-github-reader

ローカルインストール

npm install mcp-github-reader

💻 使用例

独立したサーバーとして実行

# グローバルインストールの場合
mcp-github-reader

# ローカルインストールの場合
npx mcp-github-reader

Claudeとの統合

npmインストールの場合

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

"github-reader": {
  "runtime": "node",
  "command": "npx",
  "args": [
    "-y",
    "mcp-github-reader"
  ]
}

ローカルインストールの場合

"github-reader-test": {
  "command": "node",
  "args": [
    "/path/to/your/repo/src/mcp-github-reader.js"
  ]
}

/path/to/your/repoを実際のリポジトリのパスに置き換えてください。

基本的な使用法

MCPサーバーは、GitHubリポジトリとやり取りするための4つの強力なツールを提供します。

1. 単一ファイルの内容を取得

GitHubリポジトリから特定のファイルの内容を取得します。 パラメーター：

• owner：リポジトリの所有者（例：“skydeckai”）
• repo：リポジトリ名（例：“mcp-server-aidd”）
• path：リポジトリ内のファイルパス（例：“README.md”）
• branch（オプション）：ブランチ名

2. リポジトリ全体の内容を取得

指定したリポジトリから特定のパターンに一致するすべてのファイルを取得します。 パラメーター：

• owner：リポジトリの所有者
• repo：リポジトリ名
• include_patterns：含めるファイルのパターンリスト
• exclude_patterns：除外するファイルのパターンリスト
• max_files：返す最大ファイル数

3. リポジトリを分析

指定したリポジトリを分析し、詳細なレポートを返します。 パラメーター：

• repository：分析するリポジトリ（“owner/repo”形式）
• include_files：ファイル内容を含めるかどうか

4. ファイルを検索

指定したリポジトリ内で特定のクエリに一致するファイルを検索します。 パラメーター：

• repository：検索するリポジトリ
• query：検索クエリ
• file_type：ファイルタイプ（オプション）

高度な使用法

単一ファイルの内容を取得する例

{
  "name": "get_individual_file_content",
  "parameters": {
    "owner": "skydeckai",
    "repo": "mcp-server-aidd",
    "path": "README.md"
  }
}

リポジトリ全体の内容を取得する例

{
  "name": "get_entire_repo_contents",
  "parameters": {
    "owner": "skydeckai",
    "repo": "mcp-server-aidd",
    "include_patterns": ["*.js", "*.json", "*.md"],
    "exclude_patterns": ["*.test.js", "node_modules/*"],
    "max_files": 30
  }
}

リポジトリを分析する例

{
  "name": "analyze_repository",
  "parameters": {
    "repository": "skydeckai/mcp-server-aidd",
    "include_files": true
  }
}

📚 ドキュメント

制限事項

• 現在は、公共のGitHubリポジトリのみをサポートしています。
• プライベートリポジトリや認証はサポートされていません。
• GitHub APIのレート制限（認証なしのリクエストは1時間に60回）に制約されます。

📄 ライセンス

このソフトウェアはApache License 2.0の下でライセンスされています。詳細については、LICENSEファイルを参照してください。

Copyright © 2025 SkyDeck AI Inc.