https://github.com/ravendb/ravendb-mcp
https://github.com/ravendb/ravendb-mcp
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ravendb/ravendb-mcp
- Owner: ravendb
- License: mit
- Created: 2026-05-22T06:24:00.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-07-15T00:30:59.000Z (10 days ago)
- Last Synced: 2026-07-15T01:26:07.075Z (10 days ago)
- Language: C#
- Size: 81.1 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# RavenDB MCP
A 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**.
## Quick start
Run it with **npx**:
```powershell
claude mcp add ravendb --scope user --env RAVENDB_URLS=http://localhost:8080 -- npx -y @ravendb/mcp
```
Or with **dnx**:
```powershell
claude mcp add ravendb --scope user --env RAVENDB_URLS=http://localhost:8080 -- dnx RavenDB.Mcp --yes
```
Or download a prebuilt executable from the [Releases](https://github.com/ravendb/ravendb-mcp/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](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](INSTALL.md#configuration-reference).
## 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](LICENSE). Building from source is covered in [INSTALL.md](INSTALL.md).
---
mcp-name: io.github.ravendb/ravendb-mcp