Cockroachdb MCP Server

🚀 CockroachDB MCP Server

This MCP server connects to a CockroachDB instance, exposes database and table schemas as resources, runs SQL queries as tools, and provides query analysis tips.

🚀 Quick Start

✨ Features

Resources

• postgres://{host}/databases/{database} - Retrieve information about a specific database.
• postgres://{host}/databases/{database}/tables/{table}/schema - Get the schema of a specific table.
• postgres://{host}/cluster-metadata/{resource} - Obtain cluster metadata (requires an authentication token).
  • Currently supported: nodes - Information about cluster nodes.

Tools

• query - Execute SQL queries with an option for execution plan analysis.

📦 Installation

1. Clone this repository.
2. Install dependencies:

pnpm install

3. Build the project:

npx tsc

⚠️ Important Note

You must build the project with tsc before using the MCP server locally.

Configuration

The server requires a database URL as a command-line argument and optionally accepts an authentication token to access the admin interface endpoints:

node dist/server.js postgres://user:password@host:port/database [auth_token]

The authentication token is used to access cluster metadata resources.

💻 Usage Examples

Using Claude Desktop

1. Open your Claude Desktop application configuration:

   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json

2. Add your server configuration:

{
  "mcpServers": {
    "cockroachdb": {
      "command": "node",
      "args": [
        "/path/to/cockroachdb-mcp-server/dist/server.js", 
        "postgres://user:password@host:port/database",
        "your_auth_token"
      ]
    }
  }
}

3. Restart Claude Desktop.

Using Cline

1. Open your Cline configuration file and select "MCP Server" from the extension settings. The path is:

2. Add your server configuration:

{
  "mcpServers": {
    "crdb": {
      "command": "node",
      "args": [
        "/path/to/cockroachdb-mcp-server/dist/server.js",
        "postgres://root@127.0.0.1:26257/testdb",
        "your_auth_token"
      ]
    }
  }
}

3. Restart Cline or start a new session.

Example Queries

Here are some example queries you can ask Claude to execute:

1. "What are the available databases in my CockroachDB instance?"
2. "Can you show the schema of the 'users' table in the 'testdb' database?"
3. "Run this query on my database: SELECT * FROM users LIMIT 10"
4. "Debug this query and suggest improvements: SELECT * FROM orders WHERE customer_id = 123"
5. "Show information about all nodes in my cluster"

Security Considerations

• Be careful when configuring database access. Consider using a read-only user if you only need to query data.
• The authentication token is used to access the CockroachDB admin interface API. Ensure the security of this token.

Troubleshooting

• If you encounter connection issues, check your database credentials and ensure that the CockroachDB instance is accessible from your machine.
• For SQL errors, check the server logs for detailed error messages.
• If Claude cannot see the server, verify that the configuration file is correctly formatted and the path to the server.js file is correct.
• For cluster metadata resources, ensure that a valid authentication token is provided and that the admin interface is accessible on port 8080.