MCP Server Ragdocs

🚀 MCP-サーバー-RAG ドキュメント管理ガイド

MCP-サーバーは、RAG（Retrieval Augmented Generation）技術に基づくドキュメント管理システムです。このシステムは、ドキュメントの処理、検索、管理を支援するためのさまざまなツールを提供します。

🚀 クイックスタート

MCP-サーバーを使用することで、ドキュメントの管理が効率化されます。このガイドを参考に、すぐに始めましょう。

✨ 主な機能

• ドキュメントの保存：PDF、Word、PPTなどのさまざまな形式のドキュメントをアップロードして保存できます。
• 全文検索：自然言語でのクエリを使用して、関連するドキュメント内容をすばやく見つけることができます。
• URLの取得：指定されたWebページからリンクを抽出し、その内容を分析します。
• キュー管理：インデックス化待ちのドキュメントを処理し、処理の進捗状況を監視します。

📦 インストール

Dockerを使用したインストール

docker pull sanderkooger/mcp-server-ragdocs:latest

ローカルインストール

1. リポジトリをクローンします：

   git clone https://github.com/sanderkooger/mcp-server-ragdocs.git
   cd mcp-server-ragdocs
   

2. 依存関係をインストールします：

   npm install
   

📚 ドキュメント

環境変数の設定

サーバーを起動する前に、以下の環境変数を設定してください。

ログ設定

ログはデフォルトでコンソールに出力されます。設定ファイルを変更することで、他の保存場所を指定することもできます。ログ形式は標準的な構造化ログ規範に準拠しています。

プロジェクトアーキテクチャ

このサーバーはモジュール化されたアーキテクチャで設計されており、各コンポーネントの役割が明確に分離されています。詳細なアーキテクチャ図については、ARCHITECTURE.mdを参照してください。

ツールガイド

ドキュメントの検索

自然言語クエリを使用して保存されたドキュメントを検索し、関連する段落とコンテキストを返します。

入力パラメータ：

• query (文字列)：検索するテキスト。自然言語、特定の用語、またはコードスニペットです。
• limit (数値、オプション)：返す最大結果数（1-20、デフォルト値は5）。

ソースの一覧表示

現在保存されているすべてのドキュメントのソース情報（URL、タイトル、更新日時など）を一覧表示します。

リンクの抽出

指定されたWebページからすべてのURLを抽出して分析します。抽出したURLを自動的に処理キューに追加することもできます。

入力パラメータ：

• url (文字列)：クロールするWebページの完全なアドレス。
• add_to_queue (ブール値、オプション)：抽出したURLをキューに追加するかどうか。デフォルトはfalseです。

ドキュメントの削除

指定されたURLに基づいてドキュメントを永久に削除します。各URLは保存時と完全に一致する必要があります。

入力パラメータ：

• urls (文字列配列)：削除するURLのリスト。

キューの一覧表示

現在処理待ちのすべてのドキュメントのURLを表示し、状態や処理時間などの情報を提供します。

キューの実行

キュー内のドキュメントを順番に処理し、その内容をデータベースにインデックス化します。詳細な処理進捗状況のフィードバックを提供します。

キューのクリア

キュー内のすべての処理待ちURLを削除します。この操作は元に戻せないため、注意して使用してください。

プロジェクト構造

このパッケージはモジュール化設計の原則に従っており、各部分の機能が明確です。具体的なファイルとディレクトリ構造については、PROJECT_STRUCTURE.mdを参照してください。

📄 ライセンス

このプロジェクトはMITライセンスの下でオープンソース化されています。詳細なライセンス内容については、LICENSE.mdを参照してください。

以上のガイドを参考に、MCP-サーバーを使ってドキュメントリソースをすぐに管理し始めましょう。さらに詳しい情報が必要な場合は、詳細ドキュメントを参照するか、開発チームにお問い合わせください。