Features

Natural Language Queries: Enables AI agents to query and create transactions using natural language, supporting complex workflows.
Search & Filtering: Supports efficient data retrieval and searching in CockroachDB.
Cluster Management: Check and monitor the CockroachDB cluster status, including node health and replication.
Database Management: Perform all operations related to databases, such as creation, deletion, and configuration.
Table Management: Handle tables, indexes, and schemas for flexible data modeling.
Seamless MCP Integration: Works with any MCP client for smooth communication.
Scalable & Lightweight: Designed for high-performance data operations.

Tools

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

Cluster Management

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.

Database Management

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, and schema relationships in CockroachDB.

Summary:

Create, drop, and describe tables and views.
Bulk import data into tables.
Manage indexes (create/drop).
List tables, views, 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.

Installation

The CockroachDB MCP Server supports the stdio transport. Support for the streamable-http transport will be added in a future release.

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/amin

Categories

Current Category: cockroachdb

mcp-cockroachdb

cockroachdb-mcp-server