Skip to content
GitHub (opens in a new tab)

MySQL-compatible · Integration guide

How to connect PolarDB for MySQL 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

PolarDB for MySQL uses GateRook’s MySQL connector. Alibaba Cloud's PolarDB for MySQL.

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

Use a PolarDB for MySQL cluster and copy its selected cluster or primary endpoint and port.

Prepare a database account and make sure the cluster’s access rules allow connections from your computer’s network.

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

Choose PolarDB for MySQL. Enter a Name, endpoint Host, Port, and the database User and Password.

When TLS is enabled on the chosen endpoint, set SSL mode to verify-full and provide the downloaded CA in CA certificate (PEM) if needed.

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 PolarDB for MySQL form before saving.
The PolarDB for MySQL 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 a connection fails, check the cluster endpoint, network access and that TLS is configured for that endpoint. The primary and cluster endpoints may have different routing behavior.

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

PolarDB for MySQL connector tool names and default modes in the GateRook 2.0.0 endpoint preview.
PolarDB for MySQL 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 databases and tables exposed by my PolarDB connection.”
  • “Describe the selected PolarDB MySQL table.”
  • “Count orders by status in the selected PolarDB database.”
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 PolarDB for MySQL 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)