Skip to content
GitHub (opens in a new tab)

MySQL-compatible · Integration guide

How to connect PlanetScale 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

PlanetScale uses GateRook’s MySQL connector. PlanetScale's MySQL endpoint over verified TLS, with a branch's user and password.

The screenshots show GateRook 2.0.0: the PlanetScale 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 PlanetScale, choose its card and select Continue to configure.

Use a PlanetScale Vitess/MySQL database for this card. In the database’s connection settings, select the branch and create or select branch credentials.

Choose credentials with read access for an AI that only queries data. A PlanetScale account password or API token is not the branch’s SQL password.

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

Choose PlanetScale. Enter a Name, then copy the branch’s Host, Port, generated User and Password into the matching fields.

Keep SSL mode at verify-full. Keep the branch’s provided hostname so server identity can be verified.

Select Load databases and choose the databases your AI should access. Use Database allowlist if you need a narrower boundary within that selection.

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

GateRook 2.0.0 Configure PlanetScale form before saving.
The PlanetScale 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 authentication fails, check that the generated username and password belong to the intended branch and have not been revoked. If IP restrictions are enabled for that password, permit your current client address.

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 PlanetScale on the endpoint and passing its connection test, ask your AI app to use planetscale-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.

PlanetScale connector tool names and default modes in the GateRook 2.0.0 endpoint preview.
PlanetScale 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 in my PlanetScale MySQL branch.”
  • “Describe the keys and indexes of the PlanetScale table I select.”
  • “Count records by status in my PlanetScale branch without changing data.”
Tools your AI gets
ToolWhat it doesStarts as
sql_list_schemasList tables and views in the selected MySQL-compatible 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 MySQL-compatible read statement in a read-only transaction, then roll it back. Function allowlists, database permissions and output limits apply.Read only
sql_executeRun one supported data or schema change with Approval by default. Database permissions and the environment policy apply; schema changes can commit implicitly.Approval

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

Service documentation

Keep exploring

MySQL

Connect MySQL to Claude, Codex, Cursor, VS Code or Antigravity in three steps. GateRook keeps the password; your AI reads data and asks before changes.

MariaDB

Connect MariaDB to Claude, Codex, Cursor, VS Code or Antigravity in three steps with GateRook’s MySQL connector. Changes wait for your approval.

Amazon Aurora and RDS for MySQL

Connect Amazon Aurora and RDS for MySQL 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 PlanetScale 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)