Gitmcp (GitHub To MCP)

🚀 GitMCPの使用ガイド

GitMCPは、多くのAIツールと互換性があり、GitHubとの統合が完全で、ユーザーのプライバシーを保護するオープンソースのサービスです。このガイドでは、GitMCPのインストール、設定、使用方法などについて説明します。

🚀 クイックスタート

インストールと設定

1. リポジトリのクローン

git clone https://github.com/idosal/git-mcp.git
cd git-mcp

2. 依存関係のインストール

pnpm install

3. 開発環境の起動

npm run dev
# または
pnpm dev

💻 使用例

MCPチェッカーを使用したテスト

1. MCPチェッカーツールのインストール

npx @modelcontextprotocol/inspector

2. チェッカー画面での設定

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

✨ 主な機能

機能特性

• 複数のAIツールをサポート：Cursor、VSCode、Claudeなどのツールと互換性があります。
• 完全なGitHub統合：公開リポジトリであれば、何も変更することなく使用できます。
• プライバシー保護：ユーザーデータを保存せず、ロボットプロトコルに準拠しています。
• 無料サービス：完全にオープンソースで、使用コストは一切かかりません。

核心機能

1. ドキュメント取得ツール

• fetch_<repo-name>_documentation：プロジェクトの主要なドキュメント（例：llms.txt）を取得します。

2. スマート検索

• search_<repo-name>_documentation：クエリを使ってドキュメント内の関連内容を検索します。
• search_<repo-name>_code：コードベース内で正確な検索を行います。

3. URLコンテンツ解析

• fetch_url_content：ドキュメント内のリンクから情報を取得します。

ワークフロー

1. ユーザーが質問を入力します。
2. AIツールが外部コンテキストが必要かどうかを分析します。
3. 必要な場合は、AIがMCPプロトコルを介してGitMCPサービスを呼び出します。
4. GitMCPが関連するドキュメントまたはコードを検索し、結果を返します。
5. AIが取得したコンテキストに基づいて回答を生成します。

📚 ドキュメント

よくある質問

モデルコンテキストプロトコルとは何ですか？

モデルコンテキストプロトコル（Model Context Protocol, MPT） は、AIアシスタントが構造化された方法で外部ソースから追加情報を要求し、受け取ることを可能にする標準です。これにより、AIの理解と性能が向上します。

どのAIツールがサポートされていますか？

GitMCPは、モデルコンテキストプロトコルをサポートするすべてのAIツールと互換性があります。Cursor、VSCode、Claudeなどが含まれます。

🔧 技術詳細

プライバシー保護

• データ保存なし：ユーザーのクエリや個人データを保存しません。
• ロボットプロトコルに準拠：GitHubプロジェクトにアクセスする前に、robots.txt で指定されたルールを確認し、遵守します。
• オープンソース：独立してデプロイできるため、使用環境の安全性が保証されます。

貢献ガイド

参加方法

私たちはあらゆる形の貢献を歓迎します。詳細な要件については、貢献ガイド を参照してください。

開発フロー

1. リポジトリをクローンします。
2. 機能ブランチを作成します。
3. コードをコミットします。
4. Pull Requestを送信します。

📄 ライセンス

このプロジェクトは Apache License 2.0 の下でオープンソースです。

⚠️ 重要提示

GitMCPはオープンソースプロジェクトであり、一切の保証責任を負いません。使用する前に、関連する契約書やドキュメントをよく読み、すべての適用される法律や規制に準拠していることを確認してください。