# TiDB Cloud

```json
{
  "name": "TiDB Cloud",
  "slug": "tidb_cloud",
  "url": "https://composio.dev/toolkits/tidb_cloud",
  "markdown_url": "https://composio.dev/toolkits/tidb_cloud.md",
  "logo_url": "https://logos.composio.dev/api/tidb_cloud",
  "categories": [
    "developer tools & devops"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-10-04T15:10:21.027Z"
}
```

![TiDB Cloud logo](https://logos.composio.dev/api/tidb_cloud)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with TiDB Cloud MCP or direct API to manage clusters, review IAM access, inspect billing resources, and operate Data Service endpoints through natural language.

## Summary

TiDB Cloud is a fully managed, distributed SQL database service for running TiDB without managing infrastructure.
Use it to scale transactional and analytical workloads with high availability, MySQL compatibility, and cloud-native operations.

## Categories

- developer tools & devops

## Toolkit Details

- Tools: 10

## Images

- Logo: https://logos.composio.dev/api/tidb_cloud

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for TiDB Cloud.
  - Setup:
    - Configure Api Key credentials for TiDB Cloud.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- List TiDB Cloud projects and clusters
- Check Dedicated cluster billing usage
- Review TiDB Cloud IAM user roles

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `TIDB_CLOUD_GET_CLUSTER` | Get Cluster | Get details for one Starter/Essential instance or Dedicated cluster by ID. |
| `TIDB_CLOUD_GET_MONTHLY_BILL` | Get Monthly Bill | Return the TiDB Cloud organization bill for one calendar month. |
| `TIDB_CLOUD_LIST_AUDIT_LOGS` | List Audit Logs | Search TiDB Cloud organization audit logs by time range, event type, or keyword and return one page of results. |
| `TIDB_CLOUD_LIST_BRANCHES` | List Branches | List database branches for a TiDB Cloud Starter or Essential instance. Returns one page and a continuation cursor. |
| `TIDB_CLOUD_LIST_CLUSTERS` | List Clusters | List TiDB Cloud Starter/Essential instances or Dedicated clusters, with product-specific filters. Returns one page and a continuation cursor. |
| `TIDB_CLOUD_LIST_DATA_APP_DEPLOYMENTS` | List Data App Deployments | List one page of deployments and deployment status for a TiDB Cloud Data Service application, plus a continuation cursor. |
| `TIDB_CLOUD_LIST_DATA_APPS` | List Data Apps | List TiDB Cloud Data Service applications in a project, returning one page and a continuation cursor. |
| `TIDB_CLOUD_LIST_IMPORT_TASKS` | List Import Tasks | List one page of import tasks for a TiDB Cloud Starter/Essential instance or Dedicated cluster, including status, progress, source, timestamps, errors, and a continuation cursor. |
| `TIDB_CLOUD_LIST_ORGANIZATION_MEMBERS` | List Organization Members | List one page of TiDB Cloud organization members with optional identity, assignment, role, and status filters, plus a continuation cursor. |
| `TIDB_CLOUD_LIST_REGIONS` | List Regions | List regions available for Starter/Essential or Dedicated clusters, optionally filtering Dedicated regions. Returns one page and a continuation cursor. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK, the OpenAI provider, and the OpenAI SDK
```python
pip install composio composio_openai openai
```

```typescript
npm install @composio/core @composio/openai openai
```

#### Path 1, Step 2: Create a Composio session

Initialize Composio with the OpenAI Responses provider and create a session scoped to TiDB Cloud
```python
import json
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
client = OpenAI()

session = composio.create(user_id="your-user-id", toolkits=["tidb_cloud"])
tools = session.tools()
```

```typescript
import OpenAI from "openai";
import { Composio } from "@composio/core";
import { OpenAIResponsesProvider } from "@composio/openai";

const composio = new Composio({ provider: new OpenAIResponsesProvider() });
const client = new OpenAI();

const session = await composio.create("your-user-id", { toolkits: ["tidb_cloud"] });
const tools = await session.tools();
```

#### Path 1, Step 3: Run TiDB Cloud tools with your agent

Send a request, execute the TiDB Cloud tool calls through the session, and print the final answer
```python
response = client.responses.create(
    model="gpt-5.6-sol",
    tools=tools,
    input=[{"role": "user", "content": "List all TiDB Cloud projects and summarize their cluster status"}],
)

while True:
    tool_calls = [o for o in response.output if o.type == "function_call"]
    if not tool_calls:
        break
    results = composio.provider.handle_tool_calls(response=response, session=session)
    response = client.responses.create(
        model="gpt-5.6-sol",
        tools=tools,
        previous_response_id=response.id,
        input=[
            {"type": "function_call_output", "call_id": call.call_id, "output": json.dumps(results[i])}
            for i, call in enumerate(tool_calls)
        ],
    )

print(response.output_text)
```

```typescript
let response = await client.responses.create({
  model: "gpt-5.6-sol",
  tools,
  input: [{ role: "user", content: "List all TiDB Cloud projects and summarize their cluster status" }],
});

while (response.output.some((o) => o.type === "function_call")) {
  const outputs = await composio.provider.handleToolCalls(session, response.output);
  response = await client.responses.create({
    model: "gpt-5.6-sol",
    tools,
    previous_response_id: response.id,
    input: outputs,
  });
}

console.log(response.output_text);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and your agent framework
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/mcp @ai-sdk/openai
```

#### Path 2, Step 2: Create a session with MCP enabled

Create a session scoped to TiDB Cloud and read its MCP URL and headers
```python
from composio import Composio

composio = Composio()
session = composio.create(user_id="your-user-id", toolkits=["tidb_cloud"], mcp=True)
```

```typescript
import { Composio } from "@composio/core";

const composio = new Composio();
const { mcp } = await composio.create("your-user-id", {
  toolkits: ["tidb_cloud"],
  mcp: true,
});
```

#### Path 2, Step 3: Connect your agent to the MCP server

Pass the session's MCP URL and headers to your agent and run a TiDB Cloud request
```python
import asyncio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, AssistantMessage, TextBlock

options = ClaudeAgentOptions(
    mcp_servers={
        "composio": {
            "type": "http",
            "url": session.mcp.url,
            "headers": session.mcp.headers,
        }
    },
    system_prompt="You are a helpful assistant with access to TiDB Cloud tools.",
    tools=[],
    allowed_tools=["mcp__composio__*"],
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query("List all TiDB Cloud projects and summarize their cluster status")
        async for message in client.receive_response():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, TextBlock):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { createMCPClient } from "@ai-sdk/mcp";
import { openai } from "@ai-sdk/openai";
import { generateText, stepCountIs } from "ai";

const client = await createMCPClient({
  transport: { type: "http", url: mcp.url, headers: mcp.headers },
});

const { text } = await generateText({
  model: openai("gpt-5.6-sol"),
  tools: await client.tools(),
  prompt: "List all TiDB Cloud projects and summarize their cluster status",
  stopWhen: stepCountIs(10),
});

console.log(text);
await client.close();
```

## Why Use Composio?

### 1. AI Native TiDB Cloud Integration

- Supports both TiDB Cloud MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable TiDB Cloud control-plane actions
- Rich coverage for Starter, Essential, Dedicated, IAM, billing, and Data Service resources

### 2. Managed Auth

- Secure API key handling so your agents don't need hard-coded TiDB Cloud credentials
- Central place to manage, scope, and revoke TiDB Cloud access
- Per user and per environment credentials for safer database operations

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Clear schemas help agents understand TiDB Cloud projects, clusters, IAM roles, billing, and Data Service endpoints
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access TiDB Cloud
- Scoped, least privilege access to TiDB Cloud projects, clusters, IAM, and billing resources
- Full audit trail of agent actions to support review and compliance

## Use TiDB Cloud with any AI Agent Framework

Choose a framework you want to connect TiDB Cloud with:

None listed.

## Related Toolkits

- [Supabase](https://composio.dev/toolkits/supabase) - Supabase is an open-source backend platform offering scalable Postgres databases, authentication, storage, and real-time APIs. It lets developers build modern apps without managing infrastructure.
- [Codeinterpreter](https://composio.dev/toolkits/codeinterpreter) - Codeinterpreter is a Python-based coding environment with built-in data analysis and visualization. It lets you instantly run scripts, plot results, and prototype solutions inside supported platforms.
- [GitHub](https://composio.dev/toolkits/github) - GitHub is a code hosting platform for version control and collaborative software development. It streamlines project management, code review, and team workflows in one place.
- [1password](https://composio.dev/toolkits/_1password) - 1Password is a password manager and digital vault for storing logins, secrets, notes, and secure documents. It helps individuals and teams protect credentials, share access safely, and reduce password risk.
- [Ably](https://composio.dev/toolkits/ably) - Ably is a real-time messaging platform for live chat and data sync in modern apps. It offers global scale and rock-solid reliability for seamless, instant experiences.
- [Abuselpdb](https://composio.dev/toolkits/abuselpdb) - Abuselpdb is a central database for reporting and checking IPs linked to malicious online activity. Use it to quickly identify and report suspicious or abusive IP addresses.
- [Alchemy](https://composio.dev/toolkits/alchemy) - Alchemy is a blockchain development platform offering APIs and tools for Ethereum apps. It simplifies building and scaling Web3 projects with robust infrastructure.
- [Algolia](https://composio.dev/toolkits/algolia) - Algolia is a hosted search API that powers lightning-fast, relevant search experiences for web and mobile apps. It helps developers deliver instant, typo-tolerant, and scalable search without complex infrastructure.
- [Anakin](https://composio.dev/toolkits/anakin_io) - Anakin is a web automation platform offering scraping, crawling, search, and browser automation. Use it to extract structured data, automate site tasks, and monitor web changes reliably.
- [Anchor browser](https://composio.dev/toolkits/anchor_browser) - Anchor browser is a developer platform for AI-powered web automation. It transforms complex browser actions into easy API endpoints for streamlined web interaction.
- [Apiflash](https://composio.dev/toolkits/apiflash) - Apiflash is a website screenshot API for programmatically capturing web pages. It delivers high-quality screenshots on demand for automation, monitoring, or reporting.
- [Apiverve](https://composio.dev/toolkits/apiverve) - Apiverve delivers a suite of powerful APIs that simplify integration for developers. It's designed for reliability and scalability so you can build faster, smarter applications without the integration headache.
- [Appcircle](https://composio.dev/toolkits/appcircle) - Appcircle is an enterprise-grade mobile CI/CD platform for building, testing, and publishing mobile apps. It streamlines mobile DevOps so teams ship faster and with more confidence.
- [Appdrag](https://composio.dev/toolkits/appdrag) - Appdrag is a cloud platform for building websites, APIs, and databases with drag-and-drop tools and code editing. It accelerates development and iteration by combining hosting, database management, and low-code features in one place.
- [Appveyor](https://composio.dev/toolkits/appveyor) - AppVeyor is a cloud-based continuous integration service for building, testing, and deploying applications. It helps developers automate and streamline their software delivery pipelines.
- [Authyo](https://composio.dev/toolkits/authyo) - Authyo is a REST API service for passwordless authentication, OTP verification, session management, and transactional notifications. Use it to add secure login flows and user verification without building auth infrastructure from scratch.
- [AWS Marketplace MCP](https://composio.dev/toolkits/aws_marketplace_mcp) - AWS Marketplace MCP provides MCP access to AWS Marketplace's cloud software, data, and services catalog. Use it to discover, compare, and evaluate 30K+ AWS Marketplace listings faster.
- [Azure Monitor Activity Log](https://composio.dev/toolkits/azure_monitor_activity_log) - Azure Monitor Activity Log is Azure's service that records management and control-plane events for a subscription. Use it to audit changes, troubleshoot issues, and track resource operations across your Azure resources.
- [Backendless](https://composio.dev/toolkits/backendless) - Backendless is a backend-as-a-service platform for mobile and web apps, offering database, file storage, user authentication, and APIs. It helps developers ship scalable applications faster without managing server infrastructure.
- [Baserow](https://composio.dev/toolkits/baserow) - Baserow is an open-source no-code database platform for building collaborative data apps. It makes it easy for teams to organize data and automate workflows without writing code.

## Frequently Asked Questions

### Do I need my own developer credentials to use TiDB Cloud with Composio?

Yes, TiDB Cloud requires you to configure your own API key. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)