TiDB Cloud MCP integration for AI agents.
Connect AI agents to TiDB Cloud through 17 structured actions, including get api key, show cloud providers, and get branch. Review authentication, inputs, wo…
- ACTION CONTRACTS
- 17
- AUTHENTICATION
- Custom credentials
- SOURCE STATUS
- Provider-backed
CATALOG SOURCE REVIEWED AUGUST 23, 2026 / ACTION NAMES AND SCHEMAS DERIVED FROM WORKING MACHINES PROVIDER SOURCE
CAPABILITY PROFILE
What the TiDB Cloud integration exposes
The TiDB Cloud Agent App exposes 17 provider-backed actions for data and developer tools work. Its current contract lets an authorized agent fetch one tidb cloud api key by access key, list cloud providers available for tidb cloud dedicated clusters, and fetch one tidb cloud starter or essential branch by branch id. These operations are called through Working Machines as typed capabilities rather than through browser navigation or copied UI steps.
A connection uses Custom credentials. Before execution, the agent can inspect the selected action, its required fields, declared scopes, and expected output contract. Provider credentials remain inside the Working Machines runtime; the calling agent receives the capability and its structured result, not the underlying secret.
For reliable operation, start with the narrowest action that satisfies the task, resolve stable provider identifiers before changing state, and validate the returned object or status after execution. Availability still depends on the connected TiDB Cloud account, granted provider permissions, workspace policy, region, plan, and upstream API behavior.
VERIFIED ACTION SAMPLE
Real TiDB Cloud capabilities.
Showing 12 of 17 actions. Risk labels are conservative signals based on operation names, not substitutes for provider documentation or runtime policy.
get_api_keyREADFetch one TiDB Cloud API key by access key.
INPUTS: accessKey
show_cloud_providersREVIEWList cloud providers available for TiDB Cloud Dedicated clusters.
INPUTS: projectId
get_branchREADFetch one TiDB Cloud Starter or Essential branch by branch ID.
INPUTS: clusterId / branchId / view
get_clusterREADFetch one TiDB Cloud Starter, Essential, or Dedicated cluster by ID.
INPUTS: apiFamily / clusterId / view
get_exportREADFetch one TiDB Cloud Starter or Essential export task.
INPUTS: clusterId / exportId
get_importREADFetch one TiDB Cloud Starter, Essential, or Dedicated import task.
INPUTS: apiFamily / clusterId / importId
get_node_specREADFetch one TiDB Cloud Dedicated node spec by region, component type, and key.
INPUTS: regionId / componentType / nodeSpecKey / projectId / clusterId
get_regionREADFetch one TiDB Cloud Dedicated region by region ID.
INPUTS: regionId / projectId
list_api_keysREADList TiDB Cloud API keys visible to the connected organization API key.
INPUTS: projectId / pageSize / pageToken
list_audit_logsREADList TiDB Cloud console audit logs for security and change tracking.
INPUTS: pageSize / pageToken / startTime / endTime / auditEventTypes
list_branchesREADList TiDB Cloud Starter or Essential branches for a cluster.
INPUTS: clusterId / pageSize / pageToken
list_clustersREADList TiDB Cloud Starter, Essential, or Dedicated clusters.
INPUTS: apiFamily / projectId / clusterIds / regionIds / clusterStates
INPUT CONTRACTS
Know what the action needs before it runs.
get_api_key
accessKeyOPTIONAL- The public access key value of the TiDB Cloud API key to fetch.
show_cloud_providers
projectIdOPTIONAL- The project ID used to filter available cloud providers.
get_branch
clusterIdREQUIRED- The TiDB Cloud Starter or Essential cluster ID.
branchIdREQUIRED- The TiDB Cloud branch ID to fetch.
viewOPTIONAL- The detail level for the branch response.
get_cluster
apiFamilyREQUIRED- The TiDB Cloud API family to query.
clusterIdREQUIRED- The TiDB Cloud cluster ID to fetch.
viewOPTIONAL- The detail level for Starter and Essential clusters.
PROVIDER-SPECIFIC WORKFLOWS
Jobs this Agent App can support
Inspect Get Api Key
Fetch one TiDB Cloud API key by access key. Use this as a bounded discovery step, retain the returned identifier, and avoid expanding the read beyond the task's stated scope.
get_api_keyVerify with Get Branch
Fetch one TiDB Cloud Starter or Essential branch by branch ID. Compare the returned provider state with the intended outcome and preserve stable IDs or canonical links in the run record.
get_branchSAFETY BOUNDARY
Operate TiDB Cloud with explicit limits
- Authorize TiDB Cloud with Custom credentials and grant only the provider access required by the selected actions.
- The current action names appear read-oriented, but returned TiDB Cloud data may still be sensitive and should be minimized before it enters model context.
- Do not infer permission from catalog visibility. Workspace policy, connection identity, and upstream authorization still govern execution.
- No provider scope string is declared on the sampled actions. Verify the connected account's actual permissions in TiDB Cloud rather than assuming unrestricted access.
- After a call, inspect the structured result and execution record before reporting that the TiDB Cloud task completed successfully.
CONNECTION MODEL
Custom credentials
TiDB Cloud uses Custom credentials. Connection requirements and availability are determined by the provider and the Working Machines deployment.
Working Machines stores provider credentials behind the execution boundary. An agent can use an authorized connection identity, but catalog discovery alone does not reveal OAuth tokens, API keys, or provider secrets.
- READ SIGNALS
- 15
- WRITE SIGNALS
- 0
- HIGH IMPACT
- 0
- REVIEW SIGNALS
- 2
EVIDENCE AND AVAILABILITY
Provider reference
Action names, input fields, authentication types, and counts on this page are generated from the Working Machines provider catalog. Provider behavior, quotas, object semantics, account eligibility, and regional availability remain governed by TiDB Cloud.