RAG Documentation

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

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

🚀 クイックスタート

依存関係のインストール

以下のツールがインストールされていることを確認してください。

• Node.js (推奨バージョン 14+)
• Docker (Docker Compose を使用する場合に必要)

リポジトリのクローン

git clone https://github.com/your-repository.git
cd mcp-ragdocs

サーバの起動

npm install
node index.js

デフォルトでは、サーバは http://localhost:3030 で起動します。

✨ 主な機能

この MCP サーバは以下の機能を提供します。

1. ドキュメント検索：ベクトル検索により、関連するドキュメントを効率的に検索します。
2. コンテキスト強化：AI アシスタントがドキュメントの内容を参照し、理解することを可能にし、応答の質を向上させます。
3. 多言語対応：複数の言語のドキュメントを処理および検索することができます。

📦 インストール

Docker Compose のセットアップ

以下の docker-compose.yml ファイルを使用してサービスを起動します。

version: '3'
services:
  mcp-ragdocs:
    build: .
    ports:
      - "3030:3030"
    environment:
      - EMBEDDING_PROVIDER=ollama
      - OPENAI_API_KEY=your-api-key-here

以下のコマンドを実行します。

docker-compose up --build

📚 ドキュメント

Web インターフェイス

http://localhost:3030 にアクセスすると、デフォルトの Web インターフェイスを使用してドキュメントの検索と管理を行うことができます。

設定

Cline 設定

.env ファイルに以下の環境変数を設定します。

EMBEDDING_PROVIDER=ollama  # 選択肢: ollama または openai
OPENAI_API_KEY=your-api-key-here  # 必須（OpenAI を使用する場合）
QDRANT_URL=http://localhost:6333  # オプション、デフォルトは http://localhost:6333

Claude Desktop 設定

config.json ファイルに以下の内容を設定します。

{
  "EMBEDDING_PROVIDER": "ollama",
  "OPENAI_API_KEY": "your-api-key-here",
  "QDRANT_URL": "http://localhost:6333"
}

デフォルト設定

システムはデフォルトで Ollama を埋め込みプロバイダとして使用します。最適な信頼性を得るために：

1. Ollama をローカルにインストールして実行します。
2. OpenAI をバックアップとして設定します（推奨）：

{
  "EMBEDDING_MODEL": "nomic-embed-text", // オプション
  "FALLBACK_PROVIDER": "openai",
  "FALLBACK_MODEL": "text-embedding-3-small",
  "OPENAI_API_KEY": "your-api-key-here"
}

この設定により：

• Ollama を使用して高速なローカル埋め込み生成を行います。
• Ollama が失敗した場合、自動的に OpenAI にフォールバックします。
• 必要な場合のみ外部 API を呼び出します。

注意：システムはプロバイダに応じて適切なベクトル次元を自動的に使用します。

• Ollama (nomic-embed-text)：768 次元
• OpenAI (text-embedding-3-small)：1536 次元

謝辞

このプロジェクトは qpd-v/mcp-ragdocs のフォークであり、元々は qpd-v によって開発されました。元のプロジェクトはこの実装の基礎を提供しています。元の作者である qpd-v が初期バージョンで行った革新的な作業に特別な感謝を表します。このフォークは Rahul Retnan によって改良され、より多くの機能が追加されています。

トラブルシューティング

サーバが起動しない（ポート競合）

MCP サーバがポート競合のために起動しない場合は、以下の手順を実行してください。

1. ポート 3030 を使用しているプロセスを特定し、終了させます。

npx kill-port 3030

2. MCP サーバを再起動します。
3. 問題が解決しない場合は、他のプロセスがポートを使用しているかどうかを確認します。

lsof -i :3030

4. 必要に応じて、設定でデフォルトのポートを変更することができます。