MCP Ragdocs

🚀 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 ファイルに以下の内容を追加します：

{
    "MCP server": {
        "enabled": true,
        "configuration": {
            "type": "RAGDocumentation"
        }
    }
}

📋 応答例

ドキュメント検索

入力：

• query: "RAG ドキュメントツールをどのように設定しますか？"
• limit: 5

出力：

[
    {"content": "手順 1：必要な依存関係をインストールします。", "source": "documentation/installation.md"},
    {"content": "手順 2：環境変数を設定します。", "source": "documentation/configuration.md"},
    {"content": "手順 3：サービスを起動します。", "source": "documentation/getting-started.md"}
]

ソースのリスト表示

入力：

• なし

出力：

[
    {"url": "documentation/installation.md", "title": "インストールガイド", "last_updated": "2024-01-01"},
    {"url": "documentation/configuration.md", "title": "設定ガイド", "last_updated": "2024-01-02"}
]

URL の抽出

入力：

• url: "https://example.com/documentation"
• add_to_queue: true

出力：

{
    "status": "success",
    "message": "URL がキューに追加されました。"
}

🌐 環境変数

• OPENAI_API_KEY: OpenAI API のキー（必須）
• QDRANT_URL: Qdrant サービスの URL（必須）
• VECTOR_DB_PATH: ベクトルデータベースのパス（オプション、デフォルト値：./vector_db）

このドキュメントは、RAG ドキュメント MCP サーバーの機能、ツール、および設定について説明しています。これらの機能を組み合わせることで、AI アプリケーションをサポートするためにドキュメントの内容を効果的に管理および検索することができます。