ravendb-mcp

RavenDB MCP

RavenDB 用のローカルな読み取り専用 MCP 診断サーバーです。クラスターを指定すると、AI エージェントが 21 個の読み取り専用ツールを使って、クラスター、データベース、インデックス、タスク、ストレージ、パフォーマンスの状態に加え、ログ、サポートパッケージ、データを調査できます。

クイックスタート

npx（Node.js）、dnx（.NET SDK）、または Releases のビルド済みバイナリで起動し、クライアントに追加します。RAVENDB_URLS にクラスターを設定してください。以下の例では http://localhost:8080 を使用します。

Claude Code

claude mcp add ravendb --scope user --env RAVENDB_URLS=http://localhost:8080 -- npx -y @ravendb/mcp

または、プラグインをインストールしてください。クラスターの URL を入力するよう求められます。

/plugin marketplace add ravendb/ravendb-mcp
/plugin install ravendb-mcp@ravendb

Claude Desktop

Releases から ravendb-mcp-<version>.mcpb をダウンロードし、Settings > Extensions > Advanced settings > "Install Extension…" に移動してインストールします（Anthropic のガイド）。クラスターの URL を入力するよう求められるため、編集が必要な設定はなく、Node や .NET も不要です。設定ファイルを使ったセットアップについては、INSTALL.md をご覧ください。

Codex

~/.codex/config.toml に追加します。

[mcp_servers.ravendb]
command = "npx"
args = ["-y", "@ravendb/mcp"]
env = { RAVENDB_URLS = "http://localhost:8080" }

Cursor

ボタンをクリックしてインストールします（http://localhost:8080 でインストールされます。別のクラスターを使う場合は編集してください）。または、.cursor/mcp.json に追加します。

{
  "mcpServers": {
    "ravendb": {
      "command": "npx",
      "args": ["-y", "@ravendb/mcp"],
      "env": { "RAVENDB_URLS": "http://localhost:8080" }
    }
  }
}

次に、エージェントに 「RavenDB のデータベースを一覧表示して」 と尋ねます。これらのいずれも、npx -y @ravendb/mcp の代わりに dnx RavenDB.Mcp --yes またはバイナリのパスを使用できます。HTTPS で保護されたクラスター、その他の OS、詳細な設定リファレンスについては、INSTALL.md をご覧ください。

機能

開発者向け機能

• npx、dnx、またはビルド済みバイナリを使って、1 行でインストールできます。
• 74 個から削減した 21 個のツールを提供します。各ツールは分野ごとに用意され、必要な情報を選択するためのパラメーターを備えています。
• バージョンに対応した RQL ドキュメントを rql:// リソースとして提供します。クエリに失敗すると、パーサーエラーと確認先が返されます。

安全性

• 読み取り専用です。書き込み、パッチ、削除を行うツールはなく、変更を伴うクエリは拒否されます。
• 接続文字列に含まれるシークレット（パスワード、クラウドキー、SAS トークン、AI プロバイダーのキー、証明書）は、返される JSON 内でマスキングされます。
• アクセス範囲は、クライアント証明書に付与された RavenDB の権限に限定されます。
• get_document_data と run_query は、実際のクラスターのデータをエージェントのコンテキストに返します。公開するクラスターはご自身で選択してください。SECURITY.md をご覧ください。

コンテキストウィンドウに配慮

• 段階的に情報を開示します。デフォルトでは概要を返し、要求に応じて詳細を表示します。
• 結果はページ分割されます。run_query では start と pageSize（最大 128 行）を指定でき、一覧表示ツールでは pageSize を指定できます。
• ログのエクスポートとデバッグパッケージはディスク上のアーティファクトファイルに書き込まれます。ツールが返すのはファイルのパスとバイト数であり、内容ではありません。
• 要求しない限り、クエリ結果からドキュメントごとのメタデータを省略します。

あらゆる環境で実行

• npm、NuGet、GitHub Releases、MCP Registry から配布されます。
• Windows、macOS、Linux（x64 および arm64）向けの自己完結型バイナリを提供するため、ランタイムのインストールは不要です。
• 複数クラスター構成では、クラスターごとに個別のインスタンスを実行します。

Configuration

1 つのサーバーインスタンスは1 つのクラスターを対象とします。必須の設定は URL のみです。環境変数または --config JSON ファイルで URL（および任意の証明書／アーティファクトの設定）を指定してください。

変数	必須	用途
RAVENDB_URLS	はい	クラスターのノード URL。カンマ区切りで指定し、クライアントはこれらの間でフェイルオーバーします。
RAVENDB_CERTIFICATE_PATH / _PASSWORD	いいえ	セキュリティ保護された（HTTPS）クラスター用のクライアント .pfx。セキュリティ保護されていない場合は省略してください。
RAVENDB_ARTIFACTS_PATH	いいえ	エクスポートファイルの保存先（既定では一時フォルダー）。

セキュリティ保護されたクラスターや複数クラスターの設定を含む、設定の完全なリファレンスは INSTALL.md を参照してください。

Tools

読み取り専用ツール 21 個（snake_case）。ほとんどは ファセット ツールです。対象ごとに 1 つずつ用意されており、セレクターを受け取り、指定されたセクションのみを返します。

• ファセット： get_cluster_overview、get_server_config、get_server_resources、get_network_details、get_database_stats、get_database_config、get_index、get_tasks、get_live_workload、inspect_storage、get_document_data、sample_live_feed、wait_for_completion、collect_debug_package、get_ai_agents
• 単体： list_databases、get_database_record、get_notifications、run_query、list_compare_exchange、export_server_logs

ログやデバッグパッケージなど、大容量またはバイナリの出力はファイルに書き込まれ、参照として返されます。

Privacy

RavenDB MCP はローカルで動作し、RavenDB や Anthropic にデータを一切送信しません。テレメトリーも分析データもありません。接続先は設定したクラスター URL のみです（npx／dnx でインストールする場合は npm／NuGet にも接続します）。結果はローカルのエージェントに返され、接続文字列のシークレットはマスクされます。エクスポートは、利用者が管理するローカルフォルダーにのみ書き込まれます。詳しくは PRIVACY.md を、RavenDB の企業方針については ravendb.net を参照してください。

License

MIT です。LICENSE を参照してください。ソースからのビルドについては INSTALL.md を参照してください。

---

mcp-name: io.github.ravendb/ravendb-mcp