Rag Server MCP

🚀 MCP RAG サーバー

MCP RAG サーバー は、Model Context Protocol (MCP) と Retrieval Augmented Generation (RAG) に基づくツールです。ChromaDB と Ollama と統合することで、検索強化型の生成体験を提供します。

✨ 主な機能

• 自動インデックス化：サーバー起動時に指定されたファイルを自動的にインデックス化します。
• フィルタリング機能：ワイルドカードパターンに基づいて特定のファイルやディレクトリを除外することができます。
• 統合開発環境 (IDE) プラグイン：VS Code などの IDE 用のプラグインをサポートし、コード内で直接 MCP サービスを利用できます。

🚀 クイックスタート

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

   npm install
   

2. プロジェクトのビルド：

   npm run build
   

3. サーバーの起動：

   npm start
   

4. MCP クライアントの設定： VS Code などの IDE の設定で、MCP サービスを実行中の RAG サーバーに指向させます。

📦 インストール

環境変数の設定

通常は docker-compose.yml ファイルで設定します。

• CHROMA_URL：ChromaDB サービスの URL。デフォルトは http://chromadb:8000 です。
• OLLAMA_HOST：Ollama サービスの URL。デフォルトは http://ollama:11434 です。
• INDEX_PROJECT_ON_STARTUP：起動時の自動インデックス化を有効/無効にするには、true または false に設定します。デフォルトでは有効です。
• INDEXING_EXCLUDE_PATTERNS：特定のファイルやディレクトリを除外するための、カンマ区切りの glob パターンのリスト。デフォルトでは **/node_modules/** と **/.git/** が含まれます。

🔧 開発

1. 前提条件：Node.js (LTS バージョン) と npm が必要です。
2. 依存関係のインストール：

   npm install
   

3. プロジェクトのビルド：

   npm run build
   

4. チェッカー/フォーマッターの実行：
   • コードチェック：

     npm run lint
     

   • コードフォーマット：

     npm run format
     

   • 包括的な検証 (フォーマットチェック、コードチェック、型チェックを含む)：

     npm run validate
     

5. テストの実行：
   • 単体テスト：

     npm test
     

   • カバレッジ付きの単体テスト：

     npm run test:cov
     

6. ローカルでのサーバーの実行 (Docker 不要)：
   • ChromaDB と Ollama が実行中でアクセス可能であることを確認します。
   • 環境変数 (CHROMA_URL, OLLAMA_HOST) を設定します。
   • 以下を実行します：

     npm start
     

📚 ドキュメント

完全なドキュメントは [TODO: デプロイされた VitePress サイトへのリンクを追加] にて提供されます。

🚀 将来の計画

• コードファイルのスライス戦略を改善する。
• より多くのファイルタイプ (例: PDF) をサポートする。
• クエリフィルタリング能力を向上させる。
• エンドツーエンドテストでの失敗を調査して修正する。
• エラー処理メカニズムを強化する。

📄 ライセンス

このプロジェクトは MIT License のライセンスの下で提供されています。