YugabyteDB uses GateRook’s PostgreSQL connector. YugabyteDB's YSQL API, on port 5433 by default.
The screenshots show GateRook 2.0.0: the YugabyteDB 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 YugabyteDB, choose its card and select Continue to configure.
Use YugabyteDB’s YSQL endpoint for this connection. The YCQL endpoint speaks a different protocol.
For YugabyteDB Aeon, obtain the cluster host and CA certificate and allow your computer through the cluster’s IP allowlist. Prepare a database user and password.
Enter a Name, for example yugabytedb-demo. Your AI app uses this name to choose the connection.
Choose YugabyteDB. Enter a Name, the YSQL Host, User and Password. GateRook presets Port to 5433; match it to the cluster’s YSQL listener.
For Aeon or another TLS-enabled cluster, select verify-full in SSL mode and paste its CA into CA certificate (PEM).
If necessary, set Discovery database to an accessible YSQL database, such as your application database. Select Load databases and choose the databases to expose.
Choose Development, Staging or Production to match the service. Review the connector’s limit and access settings before continuing.
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 connection fails, confirm you used YSQL rather than the YCQL port, then check the cluster IP allowlist and TLS certificate. The selected user also needs permission on the database.
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.
3. Use the connection from your AI IDE
After saving YugabyteDB on the endpoint and passing its connection test, ask your AI app to use yugabytedb-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.
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 YugabyteDB YSQL database.”
- “Describe the keys of the selected YugabyteDB table.”
- “Show the five most recent orders from my YugabyteDB connection.”
| Tool | What it does | Starts as |
|---|---|---|
sql_list_schemas | List schemas, tables and views in the selected PostgreSQL database, within the connection and policy restrictions. | Read only |
sql_describe_table | Describe a table’s columns, types, keys and indexes where available. | Read only |
sql_query | Run 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_execute | Run 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.