Skip to main content

MCP Server Reference

RushDB exposes a Model Context Protocol server for agents that need to discover, query, mutate, and traverse a project graph. Each tool publishes its input and output JSON schemas to the connected MCP client.

Use Connect with MCP for hosted OAuth, local npx and self-hosted engine setup instructions.

Endpoint​

Hosted MCP clients connect to:

https://mcp.rushdb.com/mcp

Local MCP clients run:

npx -y @rushdb/mcp-server

with RUSHDB_API_KEY for RushDB Cloud, or RUSHDB_MODE=direct, RUSHDB_ENGINE_URL and RUSHDB_ENGINE_TOKEN for a self-hosted engine.

Start Here​

The server exposes a discovery-first workflow:

  1. Call getSchemaMarkdown once at the start of a session.
  2. Call getSearchQuerySpec before building queries with dates, metrics, groupBy, relationship traversal, or vectors.
  3. Use exact label and property names returned by discovery tools.
  4. Preview and confirm destructive operations before calling them.

Reference​

PageDescription
All MCP ToolsComplete catalog of all 43 tools, grouped by task
MCP SetupHosted OAuth, local client configuration, and troubleshooting
Suggested Relationship PatternsReview and apply inferred relationship structures

Prompt​

Clients with MCP Prompts support can fetch rushdb.queryBuilder. Clients without prompt support can call getQueryBuilderPrompt to retrieve the same discovery-first instructions.