MCP Rag Server

🚀 mcp-rag-server

モデルコンテキストプロトコル（MCP）に基づく、検索強化生成（RAG）をサポートするサーバーです。ドキュメントをインデックス化し、MCPプロトコルを介して大規模言語モデルに関連情報を提供します。

🚀 クイックスタート

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

   npm install
   

2. サーバーの起動

   npm start
   

3. サンプルコマンドでのインタラクション

   node example.js
   

✨ 主な機能

• ドキュメントインデックス：ファイルを読み取り、CHUNK_SIZEに基づいてテキストを分割し、埋め込み処理のためにキューに入れます。
• 埋め込み処理：各チャンクを順番に埋め込みAPIに送信し、結果をSQLiteデータベースに保存します。
• クエリ機能：クエリ内容を埋め込み処理し、ベクトルストアから最も関連性の高いテキストチャンクを検索し、クライアントに返します。

📦 インストール

npm install mcp-rag-server

💻 使用例

基本的な使用法

汎用MCPクライアント設定

{
  "mcpServers": {
    "rag": {
      "command": "npx",
      "args": ["-y", "mcp-rag-server"],
      "env": {
        "BASE_LLM_API": "http://localhost:11434/v1",
        "EMBEDDING_MODEL": "nomic-embed-text",
        "VECTOR_STORE_PATH": "./vector_store",
        "CHUNK_SIZE": "500"
      }
    }
  }
}

サンプルインタラクション

# ドキュメントのインデックス化
>> tool:embedding_documents {"path":"./docs"}

# ステータスの確認
>> resource:embedding-status

<< rag://embedding/status
現在の完了数：123
失敗数：45
総数：678

高度な使用法

MCPツール

# ドキュメントのインデックス化
>> tool:embedding_documents {"path":"./docs"}

# ドキュメント内容のクエリ
>> tool:query_document {"query":"クエリ内容", "numberOfChunks":3}

# すべてのドキュメントURIの取得
>> resource:rag://documents

# 単一のドキュメント内容の取得
>> resource:rag://document/path/to/document.txt

MCPリソース

• rag://documents：すべてのドキュメントのURIをリストします。
• rag://document/{path}：指定されたパスのドキュメント内容を取得します。
• rag://query-document/{numberOfChunks}/{query}：指定された数のクエリに関連するドキュメント内容を取得します。
• rag://embedding/status：現在のインデックスステータス（完了、失敗、総数）を確認します。

📚 ドキュメント

設定オプション

開発

npm install
npm run build      # TypeScriptコードのコンパイル
npm start          # サーバーの起動
npm run watch      # ファイルの変更を監視

🤝 貢献

貢献を歓迎します！GitHub で問題を開くか、プルリクエストを送信してください。

📄 ライセンス

MIT 2025 Quan Le