How to integrate TiDB Cloud MCP with Mastra AI

This guide walks you through connecting TiDB Cloud to Mastra AI using the Composio tool router. By the end, you'll have a working TiDB Cloud agent that can list your clusters and branches, review audit logs, check your monthly bill, and list organization members through natural language commands. This guide will help you understand how to give your Mastra AI agent real control over a TiDB Cloud account through Composio's TiDB Cloud MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

TiDB Cloud logoTiDB Cloud
Api Key

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.

10 Tools

Introduction

This guide walks you through connecting TiDB Cloud to Mastra AI using the Composio tool router. By the end, you'll have a working TiDB Cloud agent that can list your clusters and branches, review audit logs, check your monthly bill, and list organization members through natural language commands.

This guide will help you understand how to give your Mastra AI agent real control over a TiDB Cloud account through Composio's TiDB Cloud MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate TiDB Cloud with

TL;DR

Here's what you'll learn:
  • Set up your environment so Mastra, OpenAI, and Composio work together
  • Create a Tool Router session in Composio that exposes TiDB Cloud tools
  • Connect Mastra's MCP client to the Composio generated MCP URL
  • Fetch TiDB Cloud tool definitions and attach them as a toolset
  • Build a Mastra agent that can reason, call tools, and return structured results
  • Run an interactive CLI where you can chat with your TiDB Cloud agent

What is Mastra AI?

Mastra AI is a TypeScript framework for building AI agents with tool support. It provides a clean API for creating agents that can use external services through MCP.

Key features include:

  • MCP Client: Built-in support for Model Context Protocol servers
  • Toolsets: Organize tools into logical groups
  • Step Callbacks: Monitor and debug agent execution
  • OpenAI Integration: Works with OpenAI models via @ai-sdk/openai

What is the TiDB Cloud MCP server, and what's possible with it?

The TiDB Cloud MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your TiDB Cloud account. It provides structured and secure access to your cloud database resources, billing, audit activity, organization members, and Data Service applications, so your agent can review clusters, inspect monthly bills, search audit logs, track imports, and monitor applications on your behalf.

  • Cluster and region visibility: Have your agent list Starter, Essential, or Dedicated clusters, retrieve cluster details, and check available deployment regions.
  • Billing and audit reviews: Instruct your agent to retrieve monthly organization bills and search audit activity by time range, event type, or keyword.
  • Branches and import tracking: Let the agent list database branches and review import tasks, including their status, progress, source, timing, and errors.
  • Data Service monitoring: Direct your agent to list Data Service applications in a project and check their deployments and current deployment status.
  • Organization member oversight: Have your agent review organization members and narrow the results by identity, assignment, role, or status.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Step by step09 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Node.js 18 or higher
  • A Composio account with an active API key
  • An OpenAI API key
  • Basic familiarity with TypeScript
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key.
  • You need credits or a connected billing setup to use the models.
  • Store the key somewhere safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Go to Settings and copy your API key.
  • This key lets your Mastra agent talk to Composio and reach TiDB Cloud through MCP.
3

Install dependencies

bash
npm install @composio/core @mastra/core @mastra/mcp @ai-sdk/openai dotenv

Install the required packages.

What's happening:

  • @composio/core is the Composio SDK for creating MCP sessions
  • @mastra/core provides the Agent class
  • @mastra/mcp is Mastra's MCP client
  • @ai-sdk/openai is the model wrapper for OpenAI
  • dotenv loads environment variables from .env
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
COMPOSIO_USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key_here

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates your requests to Composio
  • COMPOSIO_USER_ID tells Composio which user this session belongs to
  • OPENAI_API_KEY lets the Mastra agent call OpenAI models
5

Import libraries and validate environment

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({
  apiKey: composioAPIKey as string,
});
What's happening:
  • dotenv/config auto loads your .env so process.env.* is available
  • openai gives you a Mastra compatible model wrapper
  • Agent is the Mastra agent that will call tools and produce answers
  • MCPClient connects Mastra to your Composio MCP server
  • Composio is used to create a Tool Router session
6

Create a Tool Router session for TiDB Cloud

typescript
async function main() {
  const session = await composio.create(
    composioUserID as string,
    {
      toolkits: ["tidb_cloud"],
    },
  );

  const composioMCPUrl = session.mcp.url;
  console.log("TiDB Cloud MCP URL:", composioMCPUrl);
What's happening:
  • create spins up a short-lived MCP HTTP endpoint for this user
  • The toolkits array contains "tidb_cloud" for TiDB Cloud access
  • session.mcp.url is the MCP URL that Mastra's MCPClient will connect to
7

Configure Mastra MCP client and fetch tools

typescript
const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      nasdaq: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

console.log("Fetching MCP tools from Composio...");
const composioTools = await mcpClient.getTools();
console.log("Number of tools:", Object.keys(composioTools).length);
What's happening:
  • MCPClient takes an id for this client and a list of MCP servers
  • The headers property includes the x-api-key for authentication
  • getTools fetches the tool definitions exposed by the TiDB Cloud toolkit
8

Create the Mastra agent

typescript
const agent = new Agent({
    name: "tidb_cloud-mastra-agent",
    instructions: "You are an AI agent with TiDB Cloud tools via Composio.",
    model: "openai/gpt-5",
  });
What's happening:
  • Agent is the core Mastra agent
  • name is just an identifier for logging and debugging
  • instructions guide the agent to use tools instead of only answering in natural language
  • model uses openai("gpt-5") to configure the underlying LLM
9

Set up interactive chat interface

typescript
let messages: AiMessageType[] = [];

console.log("Chat started! Type 'exit' or 'quit' to end.\n");

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: "> ",
});

rl.prompt();

rl.on("line", async (userInput: string) => {
  const trimmedInput = userInput.trim();

  if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) {
    console.log("\nGoodbye!");
    rl.close();
    process.exit(0);
  }

  if (!trimmedInput) {
    rl.prompt();
    return;
  }

  messages.push({
    id: crypto.randomUUID(),
    role: "user",
    content: trimmedInput,
  });

  console.log("\nAgent is thinking...\n");

  try {
    const response = await agent.generate(messages, {
      toolsets: {
        tidb_cloud: composioTools,
      },
      maxSteps: 8,
    });

    const { text } = response;

    if (text && text.trim().length > 0) {
      console.log(`Agent: ${text}\n`);
        messages.push({
          id: crypto.randomUUID(),
          role: "assistant",
          content: text,
        });
      }
    } catch (error) {
      console.error("\nError:", error);
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    console.log("\nSession ended.");
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main().catch((err) => {
  console.error("Fatal error:", err);
  process.exit(1);
});
What's happening:
  • messages keeps the full conversation history in Mastra's expected format
  • agent.generate runs the agent with conversation history and TiDB Cloud toolsets
  • maxSteps limits how many tool calls the agent can take in a single run
  • onStepFinish is a hook that prints intermediate steps for debugging

Complete Code

Here's the complete code to get you started with TiDB Cloud and Mastra AI:

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set");
if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set");
if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set");

const composio = new Composio({ apiKey: composioAPIKey as string });

async function main() {
  const session = await composio.create(composioUserID as string, {
    toolkits: ["tidb_cloud"],
  });

  const composioMCPUrl = session.mcp.url;

  const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      tidb_cloud: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

  const composioTools = await mcpClient.getTools();

  const agent = new Agent({
    name: "tidb_cloud-mastra-agent",
    instructions: "You are an AI agent with TiDB Cloud tools via Composio.",
    model: "openai/gpt-5",
  });

  let messages: AiMessageType[] = [];

  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: "> ",
  });

  rl.prompt();

  rl.on("line", async (input: string) => {
    const trimmed = input.trim();
    if (["exit", "quit"].includes(trimmed.toLowerCase())) {
      rl.close();
      return;
    }

    messages.push({ id: crypto.randomUUID(), role: "user", content: trimmed });

    const { text } = await agent.generate(messages, {
      toolsets: { tidb_cloud: composioTools },
      maxSteps: 8,
    });

    if (text) {
      console.log(`Agent: ${text}\n`);
      messages.push({ id: crypto.randomUUID(), role: "assistant", content: text });
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main();

Conclusion

You've built a Mastra AI agent that can interact with TiDB Cloud through Composio's Tool Router. You can extend this further by:
  • Adding other toolkits like Gmail, Slack, or GitHub
  • Building a web-based chat interface around this agent
  • Using multiple MCP endpoints to enable cross-app workflows
TOOLS

Supported Tools

Every TiDB Cloud action and event your agent gets out of the box.

Get Cluster

Get details for one Starter/Essential instance or Dedicated cluster by ID.

Get Monthly Bill

Return the TiDB Cloud organization bill for one calendar month.

List Audit Logs

Search TiDB Cloud organization audit logs by time range, event type, or keyword and return one page of results.

List Branches

List database branches for a TiDB Cloud Starter or Essential instance.

List Clusters

List TiDB Cloud Starter/Essential instances or Dedicated clusters, with product-specific filters.

List Data App Deployments

List one page of deployments and deployment status for a TiDB Cloud Data Service application, plus a continuation cursor.

List Data Apps

List TiDB Cloud Data Service applications in a project, returning one page and a continuation cursor.

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.

List Organization Members

List one page of TiDB Cloud organization members with optional identity, assignment, role, and status filters, plus a continuation cursor.

List Regions

List regions available for Starter/Essential or Dedicated clusters, optionally filtering Dedicated regions.

FAQ

Frequently asked questions

With a standalone TiDB Cloud MCP server, the agents and LLMs can only access a fixed set of TiDB Cloud tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from TiDB Cloud and many other apps based on the task at hand, all through a single MCP endpoint.

Yes, you can. Mastra AI fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right TiDB Cloud tools.

Yes, absolutely. You can configure which TiDB Cloud scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your TiDB Cloud data and credentials are handled as safely as possible.

Start with TiDB Cloud.It takes 30 seconds.

Managed auth, hosted MCP servers, and every TiDB Cloud tool your agent needs.Free to start.

Start building