Ragdocs (Vector Documentation Search)

🚀 RAG ドキュメント MCP サーバー

このサーバーは、ベクトル検索ツールを用いたMCPサーバーの実装です。ドキュメントの検索と処理を行い、AIアシスタントが関連するドキュメントのコンテキストを利用して応答を強化できるようにします。

✨ 主な機能

• ベクトルベースのドキュメント検索と取得
• 複数のドキュメントソースのサポート
• セマンティック検索機能
• 自動化されたドキュメント処理
• リアルタイムのコンテキストによるLLM（大規模言語モデル）の強化

📚 詳細ドキュメント

search_documentation

自然言語クエリを使って、保存されたドキュメント内を検索します。一致する抜粋とそのコンテキストを返し、関連性の高い順に並べます。

入力：

• query (文字列)：ドキュメント内で検索するテキスト。自然言語クエリ、特定の用語、またはコードスニペットです。
• limit (数値、オプション)：返す最大結果数（1 - 20、デフォルト値：5）。制限を大きくするとより包括的な結果が得られますが、処理時間が長くなる場合があります。

list_sources

現在のシステムに保存されているすべてのドキュメントソースをリストします。すべてのインデックス化されたドキュメントの総合リストを返し、ソースURL、タイトル、および最後の更新日時が含まれます。このツールを使って、検索可能なドキュメントの内容を把握したり、特定のソースがインデックス化されているかを確認したりできます。

extract_urls

指定されたウェブページからすべてのURLを抽出して分析します。このツールは指定されたウェブページをクロールし、すべてのハイパーリンクを識別し、必要に応じてそれらを処理キューに追加します。

入力：

• url (文字列)：分析する完全なウェブページのURL（プロトコルを含む必要があります。例：https://）。このページは公開アクセス可能でなければなりません。
• add_to_queue (ブール値、オプション)：trueの場合、抽出されたURLを自動的に処理キューに追加して後続のインデックス付けを行います。大規模なウェブサイトで使用する場合は、キューが過多にならないように注意してください。

remove_documentation

URLを指定して特定のドキュメントソースを永久に削除します。この操作は将来の検索結果に影響を与えます。

入力：

• urls (文字列配列)：データベースから削除するURLのリスト。各URLは、ドキュメントを追加する際に使用したURLと完全に一致する必要があります。

list_queue

現在ドキュメント処理キューで待機しているすべてのURLをリストします。未処理のドキュメントソースを表示し、これらは run_queue を呼び出したときに処理されます。このツールを使ってキューの状態を監視したり、URLが正しく追加されているかを確認したり、処理のバックログを確認したりできます。

run_queue

ドキュメントキュー内のすべてのURLを処理してインデックス付けします。各URLは順番に処理され、エラー処理とリトライロジックが提供されます。処理中に進捗状況の更新が提供されます。長時間実行される操作は、キューが空になるか、回復不能なエラーが発生するまで続行されます。

clear_queue

ドキュメント処理キューからすべての未処理のURLを削除します。このツールを使って、再開する場合や不要なURLを削除する場合、または未処理の操作をキャンセルする場合にキューをクリアします。この操作は即座かつ永久的です - 後で再度処理する場合は、URLを再追加する必要があります。

💻 使用例

使用シナリオ

RAGドキュメントツールは以下のシナリオに適しています。

• AIの応答に関連するドキュメントのコンテキストを強化する
• ドキュメントを意識したAIアシスタントを構築する
• 開発者が使用するコンテキスト認識ツールを作成する
• セマンティックなドキュメント検索を実装する
• 既存の知識ベースを強化する

設定

Claude Desktopとの連携

claude_desktop_config.json に以下の内容を追加します。

{
  "mcpServers": {
    "rag-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@hannesrudolph/mcp-ragdocs"
      ],
      "env": {
        "OPENAI_API_KEY": "",
        "QDRANT_URL": "",
        "QDRANT_API_KEY": ""
      }
    }
  }
}

以下の環境変数を設定する必要があります。

• OPENAI_API_KEY：OpenAI APIと通信するためのキー
• QDRANT_URL：QdrantベクトルデータベースサービスのURL
• QDRANT_API_KEY：QdrantサービスにアクセスするためのAPIキー

📄 ライセンス

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

謝辞

このプロジェクトの基礎を築いてくれたHannes RAGに感謝します。