CockroachDB Plugin for Cursor

June 30, 2026 · View on GitHub

Release Please License

Connect Cursor directly to your CockroachDB clusters for hands-on database work — explore schemas, write optimized SQL, debug queries, and manage distributed database clusters. This plugin provides tools across MCP backends (self-hosted MCP Toolbox and managed CockroachDB Cloud MCP Server), specialized agents (DBA, Developer, Operator), skills across operational domains, and built-in safety and best-practice rules.

Installation

Install from the Cursor Marketplace, or in Cursor run:

/add-plugin cockroachdb

Prerequisites

This plugin connects to CockroachDB via MCP (Model Context Protocol). Choose the backend that fits your setup — see MCP Backends below.

For the MCP Toolbox backend (available now), install MCP Toolbox for Databases (v1.0.0+):

brew install mcp-toolbox

Configuration

Set environment variables for your CockroachDB connection:

export COCKROACHDB_HOST="your-cluster-host"
export COCKROACHDB_PORT="26257"
export COCKROACHDB_USER="your-user"
export COCKROACHDB_PASSWORD="your-password"
export COCKROACHDB_DATABASE="your-database"
export COCKROACHDB_SSLMODE="verify-full"

For CockroachDB Cloud, find connection details in the Cloud Console.

MCP Backends

MCP Toolbox (self-hosted, any cluster) — Default

Connect to any CockroachDB cluster (Cloud, self-hosted, local) via MCP Toolbox for Databases.

Install: brew install mcp-toolbox (v1.0.0+)

Run (stdio, default): toolbox --config tools.yaml --stdio

Run (HTTP): toolbox --config tools.yaml --address 0.0.0.0 --port 5000

Run (with web UI): toolbox --config tools.yaml --ui --port 5000 (opens at http://127.0.0.1:5000/ui)

Note: Toolbox must successfully connect to CockroachDB on startup. If the database is unreachable (wrong host/port, env vars not set), the server will hang during initialization and the UI will be stuck on "Fetching tools...". Make sure your COCKROACHDB_* environment variables are set and the database is accessible before starting.

ccloud CLI (cluster lifecycle, backups, DR, networking)

The ccloud CLI is an agent-ready command-line tool for full cluster lifecycle management. AI agents call ccloud directly via shell commands (not MCP protocol) -- every command supports -o json for structured output.

Install: brew install cockroachdb/tap/ccloud

Authenticate (interactive): ccloud auth login (opens browser; supports SSO via OIDC/SAMLv2)

Authenticate (org-scoped): ccloud auth login --org {organization-label}

Authenticate (headless/CI): ccloud auth login --no-redirect or use a service account API key as a bearer token.

Example agent commands:

# Provision
ccloud cluster create serverless my-cluster us-east-1 --cloud AWS -o json
ccloud cluster database create my-cluster myapp -o json

# Connect
ccloud cluster connection-string my-cluster --database myapp --sql-user maxroach -o json
# Composable: pipe into jq + psql
ccloud cluster connection-string my-cluster --database myapp --sql-user maxroach -o json \
  | jq -r '.connection_url' | xargs -I{} psql {} -c "SELECT count(*) FROM users"

# Operate
ccloud cluster list -o json
ccloud cluster info my-cluster -o json
ccloud cluster backup config update my-cluster --frequency 60 --retention 60

# Observe
ccloud audit list --limit 10 -o json
ccloud cluster versions -o json
ccloud cluster cmek get my-cluster -o json

# Scale & DR
ccloud replication create --primary-cluster prod-east --standby-cluster dr-west
ccloud cluster networking allowlist list <cluster-id> -o json

# Organize
ccloud folder create Production -o json
ccloud folder contents <folder-id> -o json

# Test resilience
ccloud cluster disruption set my-cluster --region us-east-1 --whole-region

Coverage: Provision, Connect, Operate, Observe, Scale & DR, Organize, Test resilience. See the ccloud reference for full command list.

CockroachDB Cloud MCP Server (OAuth/API key)

The official managed MCP server is hosted by Cockroach Labs and requires no infrastructure setup. Authenticate via OAuth 2.1 (PKCE) or a service account API key. Read-only by default; write access requires explicit consent.

OAuth (recommended — opens browser for consent, scopes: mcp:read, mcp:write):

{
  "mcpServers": {
    "cockroachdb-cloud": {
      "type": "http",
      "url": "https://cockroachlabs.cloud/mcp",
      "headers": {
        "mcp-cluster-id": "{your-cluster-id}"
      }
    }
  }
}

API Key (headless/autonomous agents):

{
  "mcpServers": {
    "cockroachdb-cloud": {
      "type": "http",
      "url": "https://cockroachlabs.cloud/mcp",
      "headers": {
        "mcp-cluster-id": "{your-cluster-id}",
        "Authorization": "Bearer {your-service-account-api-key}"
      }
    }
  }
}

See the quickstart guide for detailed setup.

What's Included

MCP Backends

BackendStatusTransportUse Case
cockroachdb-toolboxActivestdioAny CockroachDB cluster via MCP Toolbox
cockroachdb-cloudActiveStreamable HTTPManaged MCP Server — CockroachDB Cloud (OAuth/API key)
cockroachdb-toolbox-httpAvailableSSEMCP Toolbox remote/multi-user via HTTP

CLI Tools

ToolStatusUse Case
ccloudActiveAgent-ready CLI — cluster lifecycle, backups, DR, networking, audit. Agents call directly via shell.

Tools

MCP Toolbox (self-hosted, any cluster):

ToolDescription
cockroachdb-execute-sqlExecute SQL statements (SELECT, DDL, DML)
cockroachdb-list-schemasList all schemas in the database
cockroachdb-list-tablesList tables with columns, types, and constraints

CockroachDB Cloud MCP (managed, read tools):

ToolDescription
list_clustersList all accessible clusters
get_clusterGet detailed cluster information
list_databasesList databases in the cluster
list_tablesList tables in a database
get_table_schemaGet detailed schema for a table
select_queryExecute a SELECT statement
explain_queryExecute an EXPLAIN statement
show_running_queriesList currently executing queries

CockroachDB Cloud MCP (managed, write tools — requires write consent):

ToolDescription
create_databaseCreate a new database
create_tableCreate a new table
insert_rowsInsert rows into a table

Skills

Skills are sourced from the cockroachdb-skills submodule — a single source of truth shared across CockroachDB agent integrations.

Rules

RuleApplies To
SQL PatternsUUID primary keys, indexing, transactions, CockroachDB SQL idioms
Application PatternsORM configuration, retry logic, schema design, error handling

Development

Clone the repository:

git clone https://github.com/cockroachdb/cursor-plugin.git
cd cursor-plugin

Project Structure

.cursor-plugin/plugin.json    # Plugin manifest
skills/                       # Skills from cockroachdb-skills submodule
rules/                        # Rule sets (.mdc files)
mcp.json                      # MCP server definitions (Toolbox + Cloud MCP)
tools.yaml                    # Toolbox source & tool configuration
submodules/cockroachdb-skills # Shared skills submodule
assets/logo.svg               # Plugin logo

Releasing

This repo uses Release Please for automated releases.

  1. Use Conventional Commits (feat:, fix:) on main
  2. Release Please opens a Release PR with version bump and changelog
  3. Merge the Release PR to publish

License

Apache-2.0