Add the CockroachDB MCP server to VS Code

Config last verified Jun 1, 2026

The exact config to run CockroachDB in VS Code — paste it in, restart, and the tools load.

Prerequisites

  • VS Code installed.

Setup

1. Open .vscode/mcp.json

2. Add this configuration

Add to .vscode/mcp.json

.vscode/mcp.json
json
{
  "servers": {
    "cockroachdb": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/amineelkouhen/mcp-cockroachdb.git",
        "cockroachdb-mcp-server",
        "--url",
        "postgresql://root@localhost:26257/defaultdb"
      ],
      "env": {
        "CRDB_HOST": "<CRDB_HOST>",
        "CRDB_PORT": "<CRDB_PORT>",
        "CRDB_DATABASE": "<CRDB_DATABASE>",
        "CRDB_USERNAME": "<CRDB_USERNAME>",
        "CRDB_PWD": "<CRDB_PWD>"
      }
    }
  }
}

Heads up

  • VS Code uses the `servers` key (not `mcpServers`) and requires `type`.

3. Restart VS Code and confirm the CockroachDB tools load.

Gotchas

  • VS Code uses the `servers` key (not `mcpServers`) and requires `type`.

VS Code is the exception to every other client: its top-level key is "servers", not "mcpServers", and each entry needs an explicit "type" (for example "http" or "stdio"). Secrets are not inlined; instead you declare an "inputs" array and reference each value as ${input:id}, so VS Code prompts for it once and never writes it to disk. Remote servers connect natively with OAuth.

← Back to the CockroachDB MCP server