RavenDB.Mcp 1.0.2

Prefix Reserved
.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
{
  "inputs": [
    {
      "type": "promptString",
      "id": "RAVENDB_URLS",
      "description": "Comma-separated RavenDB node URLs of a single cluster, e.g. https://a.example:443,https://b.example:443"
    },
    {
      "type": "promptString",
      "id": "RAVENDB_CERTIFICATE_PATH",
      "description": "Path to a client .pfx certificate for secured RavenDB. Leave empty for unsecured."
    },
    {
      "type": "promptString",
      "id": "RAVENDB_CERTIFICATE_PASSWORD",
      "description": "Password for the client .pfx certificate.",
      "password": true
    },
    {
      "type": "promptString",
      "id": "RAVENDB_ARTIFACTS_PATH",
      "description": "Directory where exported artifacts (logs, packages, dumps) are written."
    }
  ],
  "servers": {
    "RavenDB.Mcp": {
      "type": "stdio",
      "command": "dnx",
      "args": ["RavenDB.Mcp@1.0.2", "--yes"],
      "env": {
        "RAVENDB_URLS": "${input:RAVENDB_URLS}",
        "RAVENDB_CERTIFICATE_PATH": "${input:RAVENDB_CERTIFICATE_PATH}",
        "RAVENDB_CERTIFICATE_PASSWORD": "${input:RAVENDB_CERTIFICATE_PASSWORD}",
        "RAVENDB_ARTIFACTS_PATH": "${input:RAVENDB_ARTIFACTS_PATH}"
      }
    }
  }
}
This package contains an MCP Server. The server can be used in VS Code by copying the generated JSON to your VS Code workspace's .vscode/mcp.json settings file. 
dotnet tool install --global RavenDB.Mcp --version 1.0.2
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest
                    


                            if you are setting up this repo
                        

                    

                
dotnet tool install --local RavenDB.Mcp --version 1.0.2
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=RavenDB.Mcp&version=1.0.2
                    


                    

                
nuke :add-package RavenDB.Mcp --version 1.0.2

RavenDB MCP

A local, read-only MCP diagnostics server for RavenDB. Point it at a cluster and your AI agent can inspect cluster, database, index, task, storage, and performance state, plus logs, support packages, and your data, across 21 read-only tools.

Quick start

Run it with npx:

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

Or with dnx:

claude mcp add ravendb --scope user --env RAVENDB_URLS=http://localhost:8080 -- dnx RavenDB.Mcp --yes

Or download a prebuilt executable from the Releases page.

Then ask the agent “list my RavenDB databases.” Other OSes, secured (HTTPS + certificate) clusters, VS Code / Claude Desktop wiring, and the full configuration reference are in INSTALL.md.

Features

Developer experience

  • One-line install with npx, dnx, or a prebuilt binary.
  • 21 tools, one per subject area, each with parameters to select what you need (reduced from 74).
  • Version-aware RQL docs are served as rql:// resources; a failed query returns the parser error and where to look.

Safety

  • Read-only: no write, patch, or delete tools, and mutating queries are rejected.
  • Connection-string secrets (passwords, cloud keys, SAS tokens, AI-provider keys, certificates) are masked in the returned JSON.
  • Access is scoped to the client certificate's RavenDB permissions.

Context-window friendly

  • Progressive disclosure: tools return an overview by default and drill into detail on request.
  • Results are paged: run_query takes start and pageSize (up to 128 rows), and the list tools take pageSize.
  • Log exports and debug packages are written to an artifact file on disk; the tool returns its path and byte size, not the contents.
  • Query results omit per-document metadata unless you request it.

Runs anywhere

  • Distributed via npm, NuGet, GitHub Releases, and the MCP Registry.
  • Self-contained binaries for Windows, macOS, and Linux (x64 and arm64), with no runtime to install.
  • Run a separate instance per cluster for multi-cluster setups.

Configuration

One server instance targets one cluster. The only required setting is the URL; pass it (and the optional certificate / artifacts settings) as environment variables or a --config JSON file:

Variable Required Purpose
RAVENDB_URLS yes Cluster node URL(s), comma-separated, the client fails over across them.
RAVENDB_CERTIFICATE_PATH / _PASSWORD no Client .pfx for secured (HTTPS) clusters. Omit for unsecured.
RAVENDB_ARTIFACTS_PATH no Where exported files are written (defaults to a temp folder).

Full configuration reference, including secured clusters and multi-cluster setups, is in INSTALL.md.

Tools

21 read-only tools (snake_case). Most are facet tools: one per subject that takes selectors and returns only the sections you ask for.

  • Facets: 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
  • Singletons: list_databases, get_database_record, get_notifications, run_query, list_compare_exchange, export_server_logs

Large or binary output (logs, debug packages) is written to a file and returned as a reference.

License

MIT. See LICENSE. Building from source is covered in INSTALL.md.

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

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
1.0.2 8 7/15/2026
1.0.1 9 7/15/2026
1.0.0 45 7/15/2026