Connect TiDB Cloud to Your AI Agent

Read cloud clusters, regions, branches, import/export tasks, and organization audit or API-key metadata. Ask your connected AI assistant to explain the results or carry out the specified operation.

17 tools Custom credential

Try a TiDB Cloud Task

Copy a prompt into your agent with the oo Skill installed. Add your page links and source notes before running it.

oo Skill TiDB Cloud

Review a Cluster

List a selected API family and retrieve cluster metadata.

/oo TiDB Cloud: List TiDB Cloud clusters with apiFamily [family], read cluster [cluster ID] using the same family, and summarize returned state.

Inspect Import Progress

Read an existing import task and explain status metadata.

/oo TiDB Cloud: List TiDB Cloud imports for apiFamily [family], cluster [cluster ID], then get import [import ID] and summarize progress.

Start Working with TiDB Cloud

  1. Install OOMOL

    Set up oo CLI and the oo Skill in your agent.

    Install OOMOL →
  2. Connect TiDB Cloud

    Provide TiDB Cloud organization public and private API keys.

    Connect TiDB Cloud →
  3. Give Your Agent a Task

    Use /oo with the pages to read, the changes to make, and where to save the result.

    Connection Guide →

Choose Your Agent

  • TiDB Cloud organization public and private API keys.
  • Cluster and import requests require apiFamily for Starter, Essential, or Dedicated APIs. These actions read metadata rather than execute SQL.

TiDB Cloud Tools

TiDB Cloud connects supported service operations to your AI assistant. Read cloud clusters, regions, branches, import/export tasks, and organization audit or API-key metadata.

Cluster Context

Read clusters, regions, node specs, and branches.

Task and Audit Records

Read import/export tasks, console audit logs, and API-key metadata.

17 tools

List Api Keys

List TiDB Cloud API keys visible to the connected organization API key.

tidb.list_api_keys

Get Api Key

Fetch one TiDB Cloud API key by access key.

tidb.get_api_key

List Audit Logs

List TiDB Cloud console audit logs for security and change tracking.

tidb.list_audit_logs

List Clusters

List TiDB Cloud Starter, Essential, or Dedicated clusters.

tidb.list_clusters

Get Cluster

Fetch one TiDB Cloud Starter, Essential, or Dedicated cluster by ID.

tidb.get_cluster

List Regions

List TiDB Cloud regions available to the connected organization API key.

tidb.list_regions

Show Node Quota

List TiDB Cloud Dedicated node quotas for the organization.

tidb.show_node_quota

Show Cloud Providers

List cloud providers available for TiDB Cloud Dedicated clusters.

tidb.show_cloud_providers

Get Region

Fetch one TiDB Cloud Dedicated region by region ID.

tidb.get_region

List Node Specs

List TiDB Cloud Dedicated node specs available in a region.

tidb.list_node_specs

Get Node Spec

Fetch one TiDB Cloud Dedicated node spec by region, component type, and key.

tidb.get_node_spec

List Imports

List TiDB Cloud Starter, Essential, or Dedicated import tasks.

tidb.list_imports

Get Import

Fetch one TiDB Cloud Starter, Essential, or Dedicated import task.

tidb.get_import

List Exports

List TiDB Cloud Starter or Essential export tasks.

tidb.list_exports

Get Export

Fetch one TiDB Cloud Starter or Essential export task.

tidb.get_export

List Branches

List TiDB Cloud Starter or Essential branches for a cluster.

tidb.list_branches

Get Branch

Fetch one TiDB Cloud Starter or Essential branch by branch ID.

tidb.get_branch

Frequently Asked Questions

What does apiFamily select?

It selects the Starter, Essential, or Dedicated API family for applicable resources.

Can I query database rows?

The current actions read cloud-management metadata; SQL execution is not included.

Will API-key metadata show the private key again?

TiDB Cloud shows the private key only when the API key is created.

Connect TiDB Cloud

About TiDB Cloud ↗