OceanBase uses GateRook’s MySQL connector. OceanBase in MySQL mode, on port 2881 by default.
The screenshots show GateRook 2.0.0: the OceanBase 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 OceanBase, choose its card and select Continue to configure.
Use an OceanBase tenant in MySQL mode. Obtain either its direct SQL address or the OceanBase Database Proxy (ODP) endpoint.
Copy the full tenant-aware username. Direct connections commonly use user@tenant; an ODP account may also include the cluster name.
Enter a Name, for example oceanbase-demo. Your AI app uses this name to choose the connection.
Choose OceanBase. Enter a Name, the Host, and the full User and Password for the tenant. The preset Port is 2881 for a direct connection; ODP normally uses 2883.
Configure SSL mode and CA certificate (PEM) for the endpoint. Use verify-full for a TLS-enabled remote listener.
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.
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 the username format against your connection path: direct and ODP formats differ. Confirm that the tenant is in MySQL mode and the selected port belongs to that endpoint.
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 OceanBase on the endpoint and passing its connection test, ask your AI app to use oceanbase-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 tables in the selected OceanBase MySQL tenant.”
- “Describe the columns of the OceanBase table I select.”
- “Count records by category in my OceanBase database.”
| Tool | What it does | Starts as |
|---|---|---|
sql_list_schemas | List tables and views in the selected MySQL-compatible 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 MySQL-compatible read statement in a read-only transaction, then roll it back. Function allowlists, database permissions and output limits apply. | Read only |
sql_execute | Run 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.