Docs RAG

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

このサーバーは、ローカルディレクトリに保存されたドキュメントに対する、検索ベースの拡張生成（RAG）システムを実装しています。TypeScript で構築され、大規模言語モデル（LLM）を通じてドキュメントを照会し、ローカルリポジトリやテキストファイルからコンテキスト情報を取得することができます。

✨ 主な機能

リソース

• ドキュメントの一覧表示とアクセス：docs:// URI を通じてアクセス可能です。
  • ドキュメントは Git リポジトリまたはテキストファイルとすることができます。
  • コンテンツのアクセスには純粋なテキスト MIME タイプを使用します。

ツール

• list_documents：DOCS_PATH ディレクトリ内のすべての利用可能なドキュメントを一覧表示します。
  • 整形されたドキュメントリストを返します。
  • 利用可能なドキュメントの総数を表示します。
• rag_query：RAG を使用してドキュメントを照会します。
  • document_id と query パラメータを受け取ります。
  • ドキュメントのコンテキストを含む AI 生成の回答を返します。
• add_git_repository：Git リポジトリを docs ディレクトリにクローンし、必要に応じてスパースチェックアウトを行います。
  • repository_url パラメータを受け取ります。
  • オプションで document_name パラメータを指定してドキュメント名をカスタマイズできます（'-docs' サフィックスを付けない簡単な説明的な名前を使用してください）。
  • 特定のディレクトリをスパースチェックアウトするためのオプションのサブディレクトリパラメータがあります。
  • リポジトリが既に存在する場合は、自動的に最新の変更を取得します。
• add_text_file：テキストファイルを docs ディレクトリにダウンロードします。
  • file_url パラメータを受け取ります。
  • wget を使用してファイルをダウンロードします。

プロンプト

• guide_documents_usage：ドキュメントと RAG 機能の使用方法を案内します。
  • 利用可能なドキュメントのリストを含みます。
  • RAG 機能の使用に関するヒント情報を提供します。

📦 インストール

Claude Desktop と一緒に使用する場合は、以下のようにサーバー設定を追加してください。

MacOS の場合：~/Library/Application Support/Claude/claude_desktop_config.json Windows の場合：%APPDATA%/Claude/claude_desktop_config.json Linux の場合：~/.config/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "docs-rag": {
      "command": "npx",
      "args": ["-y", "@kazuph/mcp-docs-rag"],
      "env": {
        "DOCS_PATH": "/path/to/your/docs",
        "GEMINI_API_KEY": "your-api-key-here"
      }
    }
  }
}

💻 使用例

基本的な使用法

1. サーバーのインストールと起動：

npm install -g @kazuph/mcp-docs-rag
mcp-docs-rag

2. rag_query ツールを使用した照会：

# 例：ドキュメント内容の照会
mcp rag_query --id your-document-id --query "your-query-here"

3. 新しいドキュメントまたはリポジトリの追加：

# 例：Git リポジトリの追加
mcp add_git_repository --url https://github.com/username/repository.git

# 例：テキストファイルの追加
mcp add_text_file --url https://example.com/document.txt

📚 ドキュメント

開発

依存関係のインストール：

npm install

サーバーのビルド：

npm run build

自動再構築機能付きの開発：

npm run watch

設定

このサーバーは、ドキュメントを保存するためのローカルディレクトリが必要です。デフォルトでは ~/docs が使用されますが、DOCS_PATH 環境変数を設定することで別の場所を構成することができます。

ドキュメント構造

ドキュメントディレクトリには以下を含めることができます。

• Git リポジトリ（クローンされたディレクトリ）
• .txt 拡張子の純粋なテキストファイル

各ドキュメントは、llama-index.ts と Google の Gemini 埋め込みを使用して個別にインデックス付けされます。

API キー

このサーバーは、ドキュメントのインデックス付けと照会に Google の Gemini API を使用します。Gemini API キーを環境変数として設定する必要があります。

export GEMINI_API_KEY=your-api-key-here

Gemini API キーは Google AI Studio ウェブサイトから取得できます。このキーをシェル構成ファイルまたは Claude Desktop の環境構成に追加してください。

🔧 技術詳細

このサーバーは、TypeScript で構築され、Google の Gemini API を使用してドキュメントのインデックス付けと照会を行います。各ドキュメントは、llama-index.ts と Google の Gemini 埋め込みを使用して個別にインデックス付けされ、大規模言語モデル（LLM）を通じてクエリを実行することができます。

📄 注意事項

⚠️ 重要提示

• アクセスするすべてのリソースと API のアクセス権を持っていることを確認してください。
• サーバーのパフォーマンスを維持するために、定期的に更新を確認してください。
• 機密情報を扱う場合は、関連するセキュリティプロトコルを遵守してください。