read-github

GitHub のドキュメントを読む

gitmcp.io MCP サービスを介して、GitHub リポジトリのドキュメントとコードにアクセスします。

URL の変換

GitHub の URL を gitmcp.io に変換します：

• github.com/owner/repo → gitmcp.io/owner/repo
• https://github.com/karpathy/llm-council → https://gitmcp.io/karpathy/llm-council

CLI の使い方

scripts/gitmcp.py スクリプトを使うと、リポジトリのドキュメントに CLI からアクセスできます。

利用可能なツールの一覧表示

python3 scripts/gitmcp.py list-tools owner/repo

ドキュメントの取得

ドキュメントファイル（README、docs など）の全内容を取得します：

python3 scripts/gitmcp.py fetch-docs owner/repo

ドキュメントの検索

リポジトリのドキュメント内をセマンティック検索します：

python3 scripts/gitmcp.py search-docs owner/repo "query"

コードの検索

GitHub Search API を使ってコードを検索します（完全一致）：

python3 scripts/gitmcp.py search-code owner/repo "function_name"

参照先 URL の取得

ドキュメント内で言及されている URL からコンテンツを取得します：

python3 scripts/gitmcp.py fetch-url owner/repo "https://example.com/doc"

ツールの直接呼び出し

任意の MCP ツールを直接呼び出します：

python3 scripts/gitmcp.py call owner/repo tool_name '{"arg": "value"}'

ツール名

ツール名には、リポジトリ名をアンダースコアでつないだプレフィックスが動的に付与されます：

• karpathy/llm-council → fetch_llm_council_documentation
• facebook/react → fetch_react_documentation
• my-org/my-repo → fetch_my_repo_documentation

利用可能な MCP ツール

どのリポジトリでも、以下のツールを利用できます：

1. fetch_{repo}_documentation - ドキュメント全体を取得します。一般的な質問には、最初に呼び出してください。
2. search_{repo}_documentation - ドキュメント内をセマンティック検索します。具体的な質問に使います。
3. search_{repo}_code - GitHub API を介してコードを検索します（完全一致）。一致するファイルを返します。
4. fetch_generic_url_content - robots.txt を遵守して、ドキュメント内で参照されている任意の URL を取得します。

ワークフロー

1. GitHub リポジトリを指定されたら、まずドキュメントを取得してプロジェクトを把握します
2. 使い方や機能に関する具体的な質問には、search-docs を使います
3. 実装や特定の関数を見つけるには、search-code を使います
4. ドキュメント内で言及されている外部参照を取得するには、fetch-url を使います