Skip to content
GitHub (opens in a new tab)

PostgreSQL-compatible · Integration guide

How to connect CockroachDB to any AI IDE (Claude/Codex/Cursor/VS Code/Antigravity)

Before you start, install GateRook and connect it to your AI development environment: Claude Desktop, Codex, Cursor, Antigravity or VS Code.

Connect your AI app

CockroachDB uses GateRook’s PostgreSQL connector. Port 26257 with the cluster's CA certificate. CockroachDB implements only part of PostgreSQL's catalogs and functions.

The screenshots show GateRook 2.0.0: the CockroachDB form, the endpoint selector, and this connector’s actual tool preview. The form and preview have not been saved. Select a screenshot to open it at full size.

1. Create a connection and enter the settings

In GateRook, open Connections, select Add connection, search for CockroachDB, choose its card and select Continue to configure.

Copy the SQL connection details and CA certificate for your CockroachDB cluster. Use a SQL user with a password and access to the intended database.

CockroachDB speaks the PostgreSQL protocol but does not implement every PostgreSQL catalog or function. Validate the queries your workflow needs.

Enter a Name, for example cockroachdb-demo. Your AI app uses this name to choose the connection.

Choose CockroachDB. Enter a Name, the cluster Host, and User and Password. The preset Port is 26257; replace it if your cluster’s connection details specify another port.

Keep SSL mode at verify-full and paste the cluster CA into CA certificate (PEM) when required.

Set Discovery database to a database this user may connect to if postgres is unavailable. Select Load databases and choose the intended database.

Choose Development, Staging or Production to match the service. Review the connector’s limit and access settings before continuing.

GateRook 2.0.0 Configure CockroachDB form before saving.
The CockroachDB configuration form. Enter your own connection settings before testing.

2. Test the connection and add it to an endpoint

Select Continue to test. GateRook checks the settings from your computer. Review the result and resolve any connection, certificate or permission error before continuing.

If the test reaches the cluster but a metadata query fails, check CockroachDB’s PostgreSQL compatibility and account permissions. Check the SQL port and CA when the connection itself fails.

After the test passes, select Continue to add to an endpoint. Choose the endpoint your AI app uses, review its tool modes, then select Save connection. GateRook offers default as the starter endpoint.

GateRook endpoint selector with default selected; no connector tool list is shown.
Choose the endpoint your AI app uses. This selector is shared across connector types; the next screenshot shows this connector’s own tools.

3. Use the connection from your AI IDE

After saving CockroachDB on the endpoint and passing its connection test, ask your AI app to use cockroachdb-demo, or the name you chose. If its tools are missing, confirm the endpoint assignment and refresh the MCP connection or start a new chat.

The preview below shows this connector’s default tools before saving. The table explains what each tool can do; connection settings, credentials and endpoint policies can restrict access further.

CockroachDB connector tool names and default modes in the GateRook 2.0.0 endpoint preview.
CockroachDB tools in the Development endpoint preview. This is an unsaved preview, not a successful service call.

Start with a small read request. Replace example resource names with existing resources your connection may access. Open Activity after the call to inspect its connection, tool, arguments, policy decision and result metadata.

Ask your AI, for example

  • “List the tables visible to my CockroachDB user.”
  • “Describe the columns in the CockroachDB table I select.”
  • “Count records by status in the selected CockroachDB database.”
Tools your AI gets
ToolWhat it doesStarts as
sql_list_schemasList schemas, tables and views in the selected PostgreSQL database, within the connection and policy restrictions.Read only
sql_describe_tableDescribe a table’s columns, types, keys and indexes where available.Read only
sql_queryRun one validated PostgreSQL read statement in a read-only transaction, then roll it back. Function allowlists, database permissions and output limits apply.Read only
sql_executeRun supported data or schema changes with Approval by default. Database permissions and the environment policy determine which changes are allowed.Approval

You can change each tool’s mode on the endpoint. Every call your AI makes appears in Activity.

Service documentation

Keep exploring

PostgreSQL

Connect PostgreSQL to Claude, Codex, Cursor, VS Code or Antigravity in three steps. Your AI runs read queries; changes wait for your approval.

Supabase

Connect Supabase to Claude, Codex, Cursor, VS Code or Antigravity with GateRook. Follow setup, connection testing and tool access with screenshots.

Neon

Connect Neon to Claude, Codex, Cursor, VS Code or Antigravity with GateRook. Follow setup, connection testing and tool access with screenshots.

Browse all integration guides

Your local MCP gateway and firewall.

Connect CockroachDB to your AI IDE.

Choose a connector. Start with read-only access. Approve changes and inspect the audit trail.

Read the getting started guide

Get GateRook

Download GateRook 2.0.0 for your Mac, or get the Windows app from Microsoft Store.

macOS

Version 2.0.0 for Apple Silicon (arm64). This download does not support Intel Macs.

Open the DMG and drag GateRook to Applications.

Windows

Available for free from Microsoft Store. Install GateRook and receive updates through the Store.

macOS release notes and checksums (opens in a new tab)