GitMCP プロジェクト詳細

🚀 プロジェクト概要

GitMCPは、無料かつオープンソースのリモートModel Context Protocol (MCP)サーバーであり、あらゆるGitHubプロジェクト（リポジトリまたはGitHub Pages）をドキュメントハブに変換できます。これにより、AIツール（Cursorなど）が最新のドキュメントやコードにアクセスできるようになり、LLMがそれらのコンテンツに遭遇したことがない場合でも、コードの幻覚をシームレスに排除します。

主要機能

• 😎 あらゆるGitHubプロジェクトの最新ドキュメント：AIアシスタントにGitHubプロジェクトのドキュメントとコードへのシームレスなアクセスを提供し、AIが必要とする正確なコンテンツを見つけるのに役立つスマート検索機能を内蔵しています。
• 🧠 幻覚の排除：GitMCPを使用することで、AIアシスタントは正確で関連性の高い回答を提供できます。
• ☁️ ゼロ設定：GitMCPはクラウドで動作するため、IDEにGitMCPのURLをMCPサーバーとして追加するだけで済みます。
• 💬 組み込みチャット：ブラウザ内チャットを通じて、リポジトリのドキュメントと直接対話できます。
• ✅ オープン、無料、そしてプライベート：完全にオープンソースで無料で利用でき、個人情報を収集したりクエリを保存したりすることはありません。自己ホストもサポートしています。

🛠️ 動作原理

GitMCPは、AIアシスタントとGitHubリポジトリを接続するためにModel Context Protocol (MCP)標準を使用します。この標準により、AIツールは外部ソースから追加情報を要求できます。

ワークフロー：

1. AIアシスタントにGitMCPのURL（例：gitmcp.io/microsoft/typescript）を提供します。
2. GitMCPはドキュメント取得、スマート検索、コード検索などのツールを公開します。
3. AIアシスタントにドキュメント/コード関連の質問をします。
4. AIアシスタントはGitMCPにそのツールを使用するようリクエストを送信します（あなたの承認が必要です）。
5. GitMCPはAIのリクエストを実行し、必要なデータを返します。
6. AIアシスタントは情報を受け取り、より正確で根拠のある、幻覚のない応答を生成します。

📋 サポートされるドキュメント形式

GitMCPは現在、以下のドキュメントを優先順位順にサポートしています。

1. llms.txt - AI最適化版のプロジェクトドキュメント
2. README.md
3. /root ディレクトリ下のその他のドキュメント

🔧 設定方法

URL形式の選択

接続したいコンテンツに応じて、以下のいずれかのURL形式を選択してください。

• GitHubリポジトリ：gitmcp.io/{owner}/{repo}
• GitHub Pagesウェブサイト：{owner}.gitmcp.io/{repo}
• 汎用ツール（あらゆるリポジトリをサポート、動的）：gitmcp.io/docs

AIツール設定例

Cursorの設定

~/.cursor/mcp.json ファイルを更新します。

{
  "mcpServers": {
    "gitmcp": {
      "url": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

Claude Desktopの設定

設定 > 開発者 > 設定を編集 で設定を置き換えます。

{
  "mcpServers": {
    "gitmcp": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://gitmcp.io/{owner}/{repo}"
      ]
    }
  }
}

Windsurfの設定

~/.codeium/windsurf/mcp_config.json ファイルを更新します。

{
  "mcpServers": {
    "gitmcp": {
      "serverUrl": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

🔨 利用可能なツール

1. ドキュメント取得 (fetch_documentation)

GitHubリポジトリから主要なドキュメントを取得し、関連ドキュメント（例：llms.txt）を検索することで、AIにプロジェクトの概要を提供します。

適用シナリオ：プロジェクトの目的、機能、または入門ガイドに関する一般的な質問

2. ドキュメント検索 (search_documentation)

AIが特定の検索クエリを使用してリポジトリのドキュメント内を検索できるようにします。すべてのドキュメントを読み込むのではなく、スマート検索を使用して関連する部分を見つけます。

適用シナリオ：プロジェクト内の特定の機能、関数、または概念に関する具体的な質問

3. リンクコンテンツ取得 (fetch_link_content)

AIがドキュメント内で言及されているリンクから情報を取得するのを助け、これらのリンクのコンテンツを取得してAIが読みやすい形式に変換します。

適用シナリオ：ドキュメントが質問への回答に役立つ外部情報を参照している場合

4. コード検索 (search_code)

GitHubのコード検索機能を使用してリポジトリの実際のコード内を検索し、AIが特定のコード例や実装の詳細を見つけるのを助けます。

適用シナリオ：実装例やドキュメントでカバーされていない技術的な詳細が必要な場合

📊 バッジ統合

GitMCPはリポジトリバッジを提供しており、ユーザーはIDEやブラウザを通じてドキュメントに素早くアクセスでき、GitMCPを介してドキュメントにアクセスされた回数を表示します。

バッジの追加

README.mdに以下のコードを追加します。

[![GitMCP](https://img.shields.io/endpoint?url=https://gitmcp.io/badge/OWNER/REPO)](https://gitmcp.io/OWNER/REPO)

バッジのカスタムパラメータ

パラメータ	説明	デフォルト値	例
color	バッジの値の色	aquamarine	?color=green
label	バッジのラベル	GitMCP	Documentation

🛡️ プライバシーとセキュリティ

• プライバシーへのコミットメント：GitMCPはユーザーのプライバシーを深く重視しており、認証を必要とせず、個人を特定できる情報にアクセスしたり保存したりすることはありません。
• クエリの不保存：プロキシによって送信されたいかなるクエリも保存しません。
• オープンソースの透明性：オープンソースプロジェクトとして、あなたの環境に独立してデプロイできます。
• オンデマンドアクセス：公開されているコンテンツにのみアクセスし、ユーザーがクエリを発行した場合にのみアクセスします。
• ルール遵守：GitHub Pagesウェブサイトにアクセスする前にrobots.txtのルールを確認し、ウェブサイト所有者が設定した指示に従います。

🚦 使用制限

GitMCPは、クエリが発行された場合にのみコンテンツにアクセスし、リポジトリを自動的にクロールすることはありません。GitHub Pagesウェブサイトについては、robots.txtのルールを確認し、それに従います。これにより、ウェブサイト所有者はオプトアウトできます。GitMCPは、GitHubプロジェクトやそのコンテンツに関するデータを永続的に保存することはありません。

💻 開発と貢献

ローカルでの実行

# リポジトリをクローン
git clone https://github.com/idosal/git-mcp.git
cd git-mcp

# 依存関係をインストール
pnpm install

# ローカル開発実行
npm run dev # または pnpm dev

MCPインスペクターツール

# MCPインスペクターツールをインストール
npx @modelcontextprotocol/inspector

インスペクターのインターフェースで：

• 転送タイプをSSEに設定します。
• GitMCPのURL（例：http://localhost:5173/docs）を入力します。
• 「接続」をクリックします。

📄 ライセンス

本プロジェクトはApache License 2.0ライセンスで提供されています。

⚠️ 免責事項

GitMCPは「現状有姿」で提供され、いかなる種類の保証もありません。サービスの信頼性と安全性の確保に努めていますが、使用中に発生する可能性のあるいかなる損害や問題に対しても責任を負いません。GitMCPを通じてアクセスされるGitHubプロジェクトは、それぞれの所有者の利用規約に準拠します。GitMCPはGitHubまたは言及されているいかなるAIツールとも提携していません。