Mcp Cockroachdb

CockroachDB MCP Server

[](https://opensource.org/licenses/MIT) [](https://www.python.org/downloads/) [](https://mcp.so/server/cockroachdb-mcp-server/cockroachdb) [](https://archestra.ai/mcp-catalog/amineelkouhen__mcp-cockroachdb)

Overview

The CockroachDB MCP Server is a natural language interface designed for LLMs and agentic applications to manage, monitor, and query data in CockroachDB. It integrates seamlessly with MCP (Model Content Protocol) clients, such as Claude Desktop or Cursor, enabling AI-driven workflows to interact directly with your database.

Table of Contents

• [Overview](#overview)
• [Features](#features)
• [Tools](#tools)
• [Cluster Monitoring](#cluster-monitoring)
• [Database Operations](#database-operations)
• [Table Management](#table-management)
• [Query Engine](#query-engine)
• [User & Privilege Management](#user--privilege-management)
• [Vector Search](#vector-search)
• [Job Management](#job-management)
• [Backup & Restore](#backup--restore)
• [Statistics](#statistics)
• [Multi-Region](#multi-region)
• [Changefeeds](#changefeeds)
• [Cluster Admin](#cluster-admin)
• [Diagnostics](#diagnostics)
• [Installation](#installation)
• [Quick Start with uvx](#quick-start-with-uvx)
• [Development Installation](#development-installation)
• [With Docker](#with-docker)
• [Configuration](#configuration)
• [Configuration via command line arguments](#configuration-via-command-line-arguments)
• [Configuration via Environment Variables](#configuration-via-environment-variables)
• [Integrations](#integrations)
• [OpenAI Agents SDK](#openai-agents-sdk)
• [Augment](#augment)
• [Claude Desktop](#claude-desktop)
• [VS Code with GitHub Copilot](#vs-code-with-github-copilot)
• [Cursor](#cursor)
• [Testing](#testing)
• [Contributing](#contributing)
• [License](#license)
• [Quality Badge](#quality-badge)
• [Contact](#contact)

Features

• Natural-Language Queries: AI agents can query and transact via natural language.
• Cluster Monitoring: Cluster status, node health, replication, slow queries, contention, index recommendations.
• Database Operations: List, create, drop, and switch databases.
• Table Management: Create, drop, alter (add/drop/rename column), truncate, rename, describe; bulk-import; indexes, views, schemas.
• Query Engine: Parameterized SQL with json/csv/table output, multi-statement transactions, explain, history.
• User & Privilege Management: Provision SQL users and roles, grant/revoke privileges. Lets you run the agent under a scoped non-root user.
• Vector Search: Similarity search with cosine/L2/inner-product metrics (auto-detected from index opclass), C-SPANN ANN index management (v25.2+).
• Job Management: Observe and control async jobs (BACKUP, RESTORE, IMPORT, CHANGEFEED, SCHEMA CHANGE).
• Backup & Restore: Full / database / table backup and restore against s3, gs, azure, nodelocal, userfile.
• Statistics: Create and show optimizer statistics.
• Multi-Region: Regions, survival goals, locality (REGIONALBYROW etc.), zone configuration.
• Changefeeds: CDC pipelines to Kafka / webhook / cloud-storage with sink-scheme validation.
• Cluster Admin: Cluster settings, decommission/drain (gated).
• Diagnostics: Tracing spans, statement-diagnostics bundles.
• Safety First: Strict identifier validation, parameterized values, --read-only mode, explicit confirm=True for destructive ops, redacted DSN responses.
• Seamless MCP Integration: Works with any MCP client (Claude Desktop, Cursor, VS Code Copilot, OpenAI Agents SDK, etc.).
• Multiple Transports: stdio (default) and streamable HTTP.

Tools

The CockroachDB MCP Server Server provides tools to manage the data stored in CockroachDB.

The tools are organized into thirteen categories. Every write-shaped tool is gated by --read-only. Every destructive tool also requires --allow-destructive plus a per-call confirm=True parameter; see the [Safety Model](#safety-model) section.

Cluster Monitoring

Purpose: Provides tools for monitoring and managing CockroachDB clusters.

Summary:

• Get cluster health and node status.
• Show currently running queries.
• Analyze query performance statistics.
• Retrieve replication and distribution status for tables or the whole database.
• Get query execution insights with optional keyword filtering.
• Find slow queries from statement statistics with optional keyword filtering.
• Get transaction execution insights with optional keyword filtering.
• View contention events with optional table filtering.
• Get index recommendations from query insights.

Database Operations

Purpose: Handles database-level operations and connection management.

Summary:

• Connect to a CockroachDB database.
• List, create, drop, and switch databases.
• Get connection status and active sessions.
• Retrieve database settings.

Table Management

Purpose: Provides tools for managing tables, indexes, views, schemas, and relationships in CockroachDB.

Summary:

• Create, drop, describe, rename, and truncate tables (destructive ops gated).
• alter_table_add_column, alter_table_drop_column, alter_table_rename_column.
• Bulk import data into tables (CSV / Avro from s3/gs/azure/http(s)).
• Manage indexes (create/drop).
• Manage views (create/drop, list).
• Manage schemas (list_schemas, create_schema, drop_schema).
• List tables and table relationships; analyze schema structure and metadata.

Query Engine

Purpose: Executes and manages SQL queries and transactions.

Summary:

• Execute SQL queries with formatting options (JSON, CSV, table).
• Run multi-statement transactions.
• Explain query plans for optimization.
• Track and retrieve query history.

User & Privilege Management

Purpose: Manage SQL users, roles, and privileges. Use this from an administrative agent to provision the agent's own scoped (non-root) user.

Summary:

• list_users, create_user, drop_user, alter_user_password.
• create_role, drop_role, grant_role, revoke_role.
• show_grants, grant_privileges, revoke_privileges.

Privileges are validated against an allowlist (SELECT, INSERT, UPDATE, DELETE, ALL, BACKUP, RESTORE, MODIFYCLUSTERSETTING, ...). Identifiers go through the same strict regex as everywhere else.

Vector Search

Purpose: Search VECTOR columns with CockroachDB's similarity operators (v25.2+) and manage C-SPANN ANN indexes.

Summary:

• vector_similarity_search with metric of cosine (default), l2, ip,

or auto (matches the existing index opclass). Returns distance and a derived similarity field.

• create_cspann_index with metric → opclass mapping

(vector_cosine_ops / vector_l2_ops / vector_ip_ops).

• drop_cspann_index (destructive).

The query vector is always passed as a $1::VECTOR parameter; identifier and optional where clause values are validated. For normalized embeddings (e.g. Takara DS1, OpenAI text-embedding-3) all three metrics rank identically; the default cosine is the safest because it ignores magnitude.

Job Management

Purpose: Observe and control long-running CockroachDB jobs (BACKUP, RESTORE, IMPORT, SCHEMA CHANGE, CHANGEFEED).

Summary:

• list_jobs (filter by status and type), get_job_status.
• pause_job, resume_job, cancel_job (destructive).

Backup & Restore

Purpose: Take and restore cluster, database, and table backups.

Summary:

• create_backup to s3/gs/azure/nodelocal/userfile destinations.
• list_backups to enumerate backups at a storage URI.
• restore_backup (destructive) with optional new_db_name.
• list_scheduled_backups.

URI schemes are validated against an allowlist; identifier targets are identifier-validated.

Statistics

Purpose: Compute and inspect the table statistics the cost-based optimizer relies on.

Summary:

• create_statistics (CREATE STATISTICS).
• show_statistics (SHOW STATISTICS FOR TABLE).

Multi-Region

Purpose: Configure multi-region behaviour: regions, survival goals, table localities, zone configurations.

Summary:

• show_regions, show_database_regions.
• add_database_region, drop_database_region (destructive).
• set_survival_goal (ZONE or REGION).
• set_table_locality (REGIONAL, REGIONAL_BY_ROW, REGIONAL_BY_TABLE, GLOBAL).
• show_zone_config for DATABASE/TABLE/INDEX.

Changefeeds

Purpose: Set up and operate CDC pipelines to Kafka, webhooks, or cloud storage.

Summary:

• create_changefeed with sink-scheme validation (kafka, webhook-http(s), s3,

gs, azure-blob, external, null), JSON or Avro format, choice of envelope.

• list_changefeeds, pause_changefeed, resume_changefeed.
• cancel_changefeed (destructive).

Cluster Admin

Purpose: Cluster-wide administration: cluster settings and node lifecycle.

Summary:

• show_cluster_setting, set_cluster_setting, reset_cluster_setting

(destructive). Setting names are validated against a strict regex.

• decommission_node, drain_node. Note that SQL-initiated decommission

only marks intent; for the full lifecycle use the cockroach node CLI.

Diagnostics

Purpose: Inspect tracing spans and request statement-diagnostics bundles.

Summary:

• get_recent_traces from crdb_internal.cluster_inflight_traces.
• list_statement_diagnostics_requests.
• request_statement_diagnostics for a statement fingerprint.

Installation

The CockroachDB MCP Server supports the stdio transport and the streamable-http transport.

Quick Start with uvx

The easiest way to use the CockroachDB MCP Server is with uvx, which allows you to run it directly from GitHub (from a branch, or use a tagged release). It is recommended to use a tagged release. The main branch is under active development and may contain breaking changes. As an example, you can execute the following command to run the 0.1.0 release:

uvx --from git+https://github.com/amineelkouhen/mcp-cockroachdb.git@0.1.0 cockroachdb-mcp-server --url postgresql://localhost:26257/defaultdb

Check the release notes for the latest version in the Releases section. Additional examples are provided below.

# Run with CockroachDB URI
uvx --from git+https://github.com/amineelkouhen/mcp-cockroachdb.git cockroachdb-mcp-server --url postgresql://localhost:26257/defaultdb

# Run with individual parameters
uvx --from git+https://github.com/amineelkouhen/mcp-cockroachdb.git cockroachdb-mcp-server --host localhost --port 26257 --database defaultdb --user root --password mypassword

# See all options
uvx --from git+https://github.com/amineelkouhen/mcp-cockroachdb.git cockroachdb-mcp-server --help

# Run with streamable HTTP transport
uvx --from git+https://github.com/amineelkouhen/mcp-cockroachdb.git cockroachdb-mcp-server \
  --url postgresql://localhost:26257/defaultdb \
  --transport http \
  --http-host 0.0.0.0 \
  --http-port 8000 \
  --http-path /mcp

Development Installation

For development or if you prefer to clone the repository:

# Clone the repository
git clone https://github.com/amineelkouhen/mcp-cockroachdb.git
cd mcp-cockroachdb

# Install dependencies using uv
uv venv
source .venv/bin/activate
uv sync

# Run with CLI interface
uv run cockroachdb-mcp-server --help

# Or run the main file directly (uses environment variables)
uv run src/main.py

Once you cloned the repository, installed the dependencies and verified you can run the server, you can configure Claude Desktop or any other MCP Client to use this MCP Server running the main file directly (it uses environment variables). This is usually preferred for development. The following example is for Claude Desktop, but the same applies to any other MCP Client.

1. Specify your CockroachDB credentials and TLS configuration
2. Retrieve your uv command full path (e.g. which uv)
3. Edit the claude_desktop_config.json configuration file

• on a MacOS, at ~/Library/Application Support/Claude/

{
    "mcpServers": {
        "cockroach": {
            "command": "",
            "args": [
                "--directory",
                "",
                "run",
                "src/main.py"
            ],
            "env": {
                "CRDB_HOST": "",
                "CRDB_PORT": "",
                "CRDB_DATABASE": "",
                "CRDB_USERNAME": "",
                "CRDB_PWD": "",
                "CRDB_SSL_MODE": "disable|allow|prefer|require|verify-ca|verify-full",
                "CRDB_SSL_CA_PATH": "",
                "CRDB_SSL_KEYFILE": "",
                "CRDB_SSL_CERTFILE": "",
            }
        }
    }
}

You can troubleshoot problems by tailing the log file.

tail -f ~/Library/Logs/Claude/mcp-server-cockroach.log

With Docker Compose (Local Development)

For local development and testing, use the provided docker-compose.yaml to spin up both CockroachDB and the MCP server:

# Start CockroachDB and MCP server
docker compose up -d

# The MCP server is available at http://localhost:8000/mcp/
# CockroachDB UI is available at http://localhost:8080

# View logs
docker compose logs -f mcp-server

# Stop and clean up
docker compose down -v

With Docker

You can use a dockerized deployment of this server. You can either build your image or use the official CockroachDB MCP Docker image.

If you'd like to build your image, the CockroachDB MCP Server provides a Dockerfile. Build this server's image with:

docker build -t mcp-cockroachdb .

Finally, configure the client to create the container at start-up. An example for Claude Desktop is provided below. Edit the claude_desktop_config.json and add:

{
  "mcpServers": {
    "cockroach": {
      "command": "docker",
      "args": ["run",
                "--rm",
                "--name",
                "cockroachdb-mcp-server",
                "-e", "CRDB_HOST=",
                "-e", "CRDB_PORT=",
                "-e", "CRDB_DATABASE=",
                "-e", "CRDB_USERNAME=",
                "mcp-cockroachdb"]
    }
  }
}

To use the CockroachDB MCP Docker image, just replace your image name (mcp-cockroachdb in the example above) with mcp/cockroachdb.

Configuration

The CockroachDB MCP Server can be configured in two ways: either via command-line arguments or via environment variables. The precedence is: CLI arguments > environment variables > default values.

Configuration via command line arguments

When using the CLI interface, you can configure the server with command line arguments:

# Basic CockroachDB connection
uvx --from git+https://github.com/amineelkouhen/mcp-cockroachdb.git cockroachdb-mcp-server \
  --host localhost \
  --port 26257 \
  --db defaultdb \
  --user root \
  --password mypassword

# Using CockroachDB URI (simpler)
uvx --from git+https://github.com/amineelkouhen/mcp-cockroachdb.git cockroachdb-mcp-server \
  --url postgresql://root@localhost:26257/defaultdb

# SSL connection
uvx --from git+https://github.com/amineelkouhen/mcp-cockroachdb.git cockroachdb-mcp-server \
  --url postgresql://user:pass@cockroach.example.com:26257/defaultdb?sslmode=verify-full&sslrootcert=path/to/ca.crt&sslcert=path/to/client.username.crt&sslkey=path/to/client.username.key

# See all available options
uvx --from git+https://github.com/amineelkouhen/mcp-cockroachdb.git cockroachdb-mcp-server --help

Available CLI Options:

• --url - CockroachDB connection URI (postgresql://user:pass@host:port/db)
• --host - CockroachDB hostname
• --port - CockroachDB port (default: 26257)
• --db - CockroachDB database name (default: defaultdb)
• --username - CockroachDB u

…

Source & license

This open-source MCP server is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: amineelkouhen
• Source: amineelkouhen/mcp-cockroachdb
• License: MIT

Install and usage instructions live in the source repository linked above.