Skip to content
GitHub (opens in a new tab)

MySQL-compatible · Integration guide

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

Vitess uses GateRook’s MySQL connector. Vitess through vtgate's MySQL port.

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

Obtain the vtgate MySQL listener address and a vtgate account. GateRook connects through that MySQL endpoint.

Use the listener port configured for your deployment. Vitess examples use 15306, while other installations expose 3306.

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

Choose Vitess. Enter a Name, the vtgate Host, its MySQL Port, and the configured User and Password.

Match SSL mode and CA certificate (PEM) to vtgate’s TLS configuration. Prefer verify-full when its listener supports verified TLS.

Select Load databases and choose the keyspaces exposed as databases. Keep the selection to the keyspaces needed for your AI workflow.

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

GateRook 2.0.0 Configure Vitess form before saving.
The Vitess 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 cannot establish a MySQL session, check the vtgate MySQL port and authentication settings. Its gRPC or web port will not work here.

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

Vitess connector tool names and default modes in the GateRook 2.0.0 endpoint preview.
Vitess 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 exposed by my Vitess keyspace.”
  • “Describe the columns of the Vitess table I select.”
  • “Run a read-only count grouped by status in the selected Vitess keyspace.”
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 Vitess 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)