Probonobonobo Sui MCP Server

🚀 MCP サーバー

MCP（Message Communication Protocol）サーバーは、FastAPI と FAISS をベースにした高速 API サービスで、主に RAG（検索強化生成）アプリケーションをサポートするために使用されます。このドキュメントでは、このサーバーの構築と使用方法について詳しく説明します。

🚀 クイックスタート

MCP サーバーを使用するには、まず必要な依存関係をインストールし、環境変数を設定する必要があります。以下に手順を示します。

依存関係のインストール

プロジェクトのルートディレクトリで次のコマンドを実行して、すべての必要な依存関係をインストールします。

pip install -r requirements.txt

環境変数の設定

.env.example ファイルをコピーして .env という名前にし、必要に応じて設定を変更します。

GITHUB_TOKEN=your_github_token_here
OPENAI_API_KEY=your_openai_api_key_here

✨ 主な機能

1. MCP API の実装 (mcp_api.py)

以下の主要なインターフェースを提供します。

• /mcp/action: retrieve_documents と index_documents の 2 種類の操作タイプをサポートします。

リクエストの例

curl -X POST "http://localhost:8000/mcp/action" -H "Content-Type: application/json" -d '{"action_type": "retrieve_documents", "payload": {"query": "What is RAG?", "top_k": 3}}'

2. ドキュメントのインデックス化 (index_move_files.py)

ドキュメントをテキストに変換し、FAISS インデックスに保存します。

python index_move_files.py --docs-dir docs/move_files --index-file data/faiss_index.bin

3. ローカルクエリ (local_query.py)

インデックスから直接関連するドキュメントを検索します。

python local_query.py "What is RAG?"

📦 インストール

依存関係のインストール

プロジェクトのルートディレクトリで次のコマンドを実行して、すべての必要な依存関係をインストールします。

pip install -r requirements.txt

環境変数の設定

.env.example ファイルをコピーして .env という名前にし、必要に応じて設定を変更します。

GITHUB_TOKEN=your_github_token_here
OPENAI_API_KEY=your_openai_api_key_here

💻 使用例

基本的な使用法

MCP API の使用

curl -X POST "http://localhost:8000/mcp/action" -H "Content-Type: application/json" -d '{"action_type": "retrieve_documents", "payload": {"query": "What is RAG?", "top_k": 3}}'

ドキュメントのインデックス化

python index_move_files.py --docs-dir docs/move_files --index-file data/faiss_index.bin

ローカルクエリ

python local_query.py "What is RAG?"

📚 ドキュメント

使用シナリオ

ケース：RAG パイプラインの実装

完全な RAG ワークフローは次のとおりです。

1. 検索クエリ: ユーザーが質問を送信します。
2. 検索: システムがベクトルデータベースから関連するドキュメントを見つけます。
3. コンテキストの構築: 検索されたドキュメントをプロンプトに整形します。
4. LLM 生成: プロンプトが LLM モデルに送信され、検索された内容と組み合わされます。
5. 強化された応答: LLM が提供された情報に基づいて回答を生成します。

このフローは rag_integration.py で完全に実装されています。

プロジェクトの拡張

機能拡張の提案

• より多くのデータソース（S3、HDFS など）をサポートする
• 分散インデックスを実装する
• ドキュメントの前処理パイプラインを追加する
• 複数の LLM プロバイダーを統合する
• 結果のキャッシュメカニズムを追加する
• 増分インデックスの更新をサポートする

貢献方法

1. このリポジトリを Fork します。
2. 機能ブランチを作成します。
3. 変更をコミットします。
4. Pull Request を作成します。

🔧 技術詳細

ディレクトリ構造

mcp_server/
├── __init__.py             # パッケージの初期化ファイル
├── main.py                # メインサーバーファイル
├── mcp_api.py             # MCP API の実装ファイル
├── index_move_files.py    # ファイルのインデックス化ツール
├── local_query.py         # ローカルクエリツール
├── download_move_files.py # GitHub Move ファイルの抽出ツール
├── rag_integration.py     # LLM 統合モジュール
├── pyproject.toml         # パッケージの設定ファイル
├── requirements.txt       # 依存関係の管理ファイル
├── .env.example           # 環境変数のサンプルファイル
├── README.md              # プロジェクトの説明ドキュメント
├── data/                  # データの保存ディレクトリ
├── docs/                  # サンプルドキュメントのディレクトリ
│   └── move_files/        # ダウンロードした Move ファイルの保存ディレクトリ
├── models/                # モデルの実装ディレクトリ
│   └── vector_store.py    # FAISS ベクトルストアの実装
└── utils/
    ├── document_processor.py  # ドキュメントの処理ツール
    └── github_extractor.py    # GitHub ファイルの抽出ツール

📄 ライセンス

LICENSE

🔗 プロジェクトのリンク

GitHub リポジトリの URL

📞 連絡先

• メール: contact@example.com
• GitHub: https://github.com/yourusername