RAG Docs

🚀 MCP 文書検索サーバー

MCP 文書検索サーバーは、指定された文書を RAG データベースに追加し、それらの文書を検索するためのサーバーです。

🚀 クイックスタート

MCP 文書検索サーバーを使用するには、以下の手順に従ってください。

📦 インストール

リポジトリのクローン

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

依存関係のインストール

npm install

プロジェクトのビルド

npm run build

📚 ドキュメント

環境変数の設定

Qdrant サービスの設定

• QDRANT_URL（必須）：Qdrant インスタンスの URL アドレス
  • ローカルで実行する場合は：http://localhost:6333
  • クラウドサービスを使用する場合は：https://your-cluster-url.qdrant.tech
• QDRANT_API_KEY（クラウドサービスで必須）：あなたの Qdrant クラウド API キー

埋め込みモデルの設定

• EMBEDDING_PROVIDER（オプション）：'ollama'（デフォルト）または 'openai' を選択
• EMBEDDING_MODEL（オプション）：
  • Ollama を使用する場合は、デフォルトは 'nomic-embed-text'
  • OpenAI を使用する場合は、デフォルトは 'text-embedding-3-small'
• OLLAMA_URL（オプション）：Ollama インスタンスの URL アドレス（デフォルト http://localhost:11434）
• OPENAI_API_KEY（OpenAI を使用する場合に必須）：あなたの OpenAI API キー

利用可能なツール

1. add_documentation

   • 指定された URL から文書を RAG データベースに追加します。
   • パラメータ：
     • url：取得する文書の URL アドレス

2. search_documentation

   • 保存された文書の中から検索を行います。
   • パラメータ：
     • query：検索クエリ内容
     • limit（オプション）：返される結果の最大数（デフォルト 5）

3. list_sources

   • 現在保存されているすべての文書のソースをリストします。
   • パラメータは必要ありません。

💻 使用例

基本的な使用法

Claude Desktop またはその他の MCP 互換クライアントで：

1. 文書の追加：

添加此文档：https://docs.example.com/api

2. 文書の検索：

搜索文档以获取关于身份验证的信息

3. ソースのリスト：

有哪些可用的文档来源？

🔧 開発ガイド

リポジトリのクローン

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

依存関係のインストール

npm install

プロジェクトのビルド

npm run build

ローカルでの実行

npm start

📄 ライセンス

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

トラブルシューティング

一般的な問題

1. Qdrant 接続エラー

错误：无法连接到 Qdrant 服务 http://localhost:6333

• Docker が実行中か確認してください。
• Qdrant コンテナが正常に実行されていることを確認してください：docker ps | grep qdrant
• コンテナを再起動してみてください。

2. Ollama モデルが見つからない

错误：模型 nomic-embed-text 未找到

• 以下のコマンドを実行してください：ollama pull nomic-embed-text
• モデルがインストールされていることを確認してください：ollama list

3. 設定パスの問題

• Windows システムでは、正しいパス区切り文字（バックスラッシュ）を使用していることを確認してください。
• .env ファイルの変数が正しく設定されていることを確認してください。

4. ポートの競合

错误：EADDRINUSE @localhost:5000

• 他のプログラムが 5000 ポートを使用していないことを確認してください。
• 利用可能な他のポートに変更してみてください。

貢献ガイド

コードの提出

1. 機能ブランチを作成します：

git checkout -b feature/your-feature-name

2. 変更をコミットします：

git add .
git commit -m "描述你所做的修改"
git push origin feature/your-feature-name

3. メインブランチに Pull Request を作成します。

問題の報告

• ISSUE を提出する前に、既存の問題を検索して重複を避けてください。
• 詳細なエラー情報と再現手順を提供してください。

MCP 文書検索サーバーをご利用いただき、ありがとうございます！詳細情報については、GitHub リポジトリをご覧ください。