{
  "markdown": "# RavenDB MCP\n\nA local, read-only [MCP](https://modelcontextprotocol.io) 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**.\n\n## Quick start\n\nLaunch it with **npx** (Node.js), **dnx** (.NET SDK), or a prebuilt binary from [Releases](https://github.com/ravendb/ravendb-mcp/releases), then add it to your client. Set `RAVENDB_URLS` to your cluster; the examples use `http://localhost:8080`.\n\n**Claude Code**\n\n```powershell\nclaude mcp add ravendb --scope user --env RAVENDB_URLS=http://localhost:8080 -- npx -y @ravendb/mcp\n```\n\nOr install the plugin, which prompts for your cluster URL:\n\n```\n/plugin marketplace add ravendb/ravendb-mcp\n/plugin install ravendb-mcp@ravendb\n```\n\n**Claude Desktop**\n\nDownload `ravendb-mcp-<version>.mcpb` from [Releases](https://github.com/ravendb/ravendb-mcp/releases), then install it under **Settings > Extensions > Advanced settings > \"Install Extension…\"** ([Anthropic's guide](https://support.claude.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop)). It prompts for your cluster URL, so there is no config to edit and no Node or .NET needed. Config-file setup is in [INSTALL.md](INSTALL.md#claude-desktop).\n\n**Codex**\n\nAdd to `~/.codex/config.toml`:\n\n```toml\n[mcp_servers.ravendb]\ncommand = \"npx\"\nargs = [\"-y\", \"@ravendb/mcp\"]\nenv = { RAVENDB_URLS = \"http://localhost:8080\" }\n```\n\n**Cursor**\n\nClick the button (installs with `http://localhost:8080`; edit for another cluster), or add `.cursor/mcp.json`:\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=ravendb&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkByYXZlbmRiL21jcCJdLCJlbnYiOnsiUkFWRU5EQl9VUkxTIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwIn19)\n\n```json\n{\n  \"mcpServers\": {\n    \"ravendb\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@ravendb/mcp\"],\n      \"env\": { \"RAVENDB_URLS\": \"http://localhost:8080\" }\n    }\n  }\n}\n```\n\nThen ask the agent *“list my RavenDB databases.”* Any of these can use `dnx RavenDB.Mcp --yes` or a binary path in place of `npx -y @ravendb/mcp`. Secured (HTTPS) clusters, other OSes, and the full configuration reference are in **[INSTALL.md](INSTALL.md)**.\n\n## Features\n\n**Developer experience**\n- One-line install with `npx`, `dnx`, or a prebuilt binary.\n- 21 tools, one per subject area, each with parameters to select what you need (reduced from 74).\n- Version-aware RQL docs are served as `rql://` resources; a failed query returns the parser error and where to look.\n\n**Safety**\n- Read-only: no write, patch, or delete tools, and mutating queries are rejected.\n- Connection-string secrets (passwords, cloud keys, SAS tokens, AI-provider keys, certificates) are masked in the returned JSON.\n- Access is scoped to the client certificate's RavenDB permissions.\n- `get_document_data` and `run_query` return real cluster data into the agent's context — you choose which cluster to expose. See [SECURITY.md](SECURITY.md).\n\n**Context-window friendly**\n- Progressive disclosure: tools return an overview by default and drill into detail on request.\n- Results are paged: `run_query` takes `start` and `pageSize` (up to 128 rows), and the list tools take `pageSize`.\n- Log exports and debug packages are written to an artifact file on disk; the tool returns its path and byte size, not the contents.\n- Query results omit per-document metadata unless you request it.\n\n**Runs anywhere**\n- Distributed via npm, NuGet, GitHub Releases, and the MCP Registry.\n- Self-contained binaries for Windows, macOS, and Linux (x64 and arm64), with no runtime to install.\n- Run a separate instance per cluster for multi-cluster setups.\n\n## Configuration\n\nOne 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:\n\n| Variable | Required | Purpose |\n| --- | --- | --- |\n| `RAVENDB_URLS` | yes | Cluster node URL(s), comma-separated, the client fails over across them. |\n| `RAVENDB_CERTIFICATE_PATH` / `_PASSWORD` | no | Client `.pfx` for secured (HTTPS) clusters. Omit for unsecured. |\n| `RAVENDB_ARTIFACTS_PATH` | no | Where exported files are written (defaults to a temp folder). |\n\nFull configuration reference, including secured clusters and multi-cluster setups, is in [INSTALL.md](INSTALL.md#configuration-reference).\n\n## Tools\n\n**21 read-only tools** (`snake_case`). Most are *facet* tools: one per subject that takes selectors and returns only the sections you ask for.\n\n- **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`\n- **Singletons:** `list_databases`, `get_database_record`, `get_notifications`, `run_query`, `list_compare_exchange`, `export_server_logs`\n\nLarge or binary output (logs, debug packages) is written to a file and returned as a reference.\n\n## Privacy\n\nRavenDB MCP runs locally and sends **no data** to RavenDB or Anthropic: no telemetry, no analytics. It connects only to the cluster URL(s) you configure (and to npm/NuGet when you install via `npx`/`dnx`), returns results to your local agent, masks connection-string secrets, and writes exports only to a local folder you control. Details in [PRIVACY.md](PRIVACY.md); RavenDB's company policy is at [ravendb.net](https://ravendb.net/legal/website/privacy-policy).\n\n## License\n\nMIT. See [LICENSE](LICENSE). Building from source is covered in [INSTALL.md](INSTALL.md).\n\n---\n\nmcp-name: io.github.ravendb/ravendb-mcp\n",
  "bytes": 5853,
  "sha": "794682c2aeb7e7512fc980b6fa8ccea1fd1ecb611b524405905bcab27ffdea0a",
  "repo_slug": "ravendb/ravendb-mcp",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_ravendb_ravendb_mcp_df89e0b4/readme"
}