How to integrate Botpress MCP with Mastra AI

This guide walks you through connecting Botpress to Mastra AI using the Composio tool router. By the end, you'll have a working Botpress agent that can list all active conversations for your bot, show issues reported for a specific bot, delete a file from a bot workspace through natural language commands. This guide will help you understand how to give your Mastra AI agent real control over a Botpress account through Composio's Botpress MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Get started for freeGet a demo
Botpress logoBotpress
Api Key

Botpress is an open-source platform for building, deploying, and managing chatbots. It helps teams automate conversations and deliver rich, interactive messaging experiences.

53 Tools

Introduction

This guide walks you through connecting Botpress to Mastra AI using the Composio tool router. By the end, you'll have a working Botpress agent that can list all active conversations for your bot, show issues reported for a specific bot, delete a file from a bot workspace through natural language commands.

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

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

Also integrate Botpress with

OpenAI Agents SDKClaude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKLlamaIndexCrewAI

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 Botpress tools
  • Connect Mastra's MCP client to the Composio generated MCP URL
  • Fetch Botpress 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 Botpress 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 Botpress MCP server, and what's possible with it?

The Botpress MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Botpress account. It provides structured and secure access to your chatbot platform, so your agent can perform actions like listing conversations, managing bot files, tracking issues, and exploring workspaces on your behalf.

  • Comprehensive conversation management: Retrieve and paginate through all chatbot conversations, making it easy to review chat history and analyze user interactions.
  • Bot issue tracking and diagnostics: List and investigate issues related to specific bots, helping you stay informed about errors or configuration problems as they arise.
  • Workspace discovery and organization: Browse both public and private workspaces, making it seamless to manage your bot environments or explore new collaborative spaces.
  • File and tag oversight: List, manage, and categorize bot files and their associated tags or tag values, streamlining bot asset organization.
  • Account information access: Instantly fetch authenticated account details so your agent always works with the latest profile and permission data.

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 Botpress 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 Botpress

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

  const composioMCPUrl = session.mcp.url;
  console.log("Botpress MCP URL:", composioMCPUrl);
What's happening:
  • create spins up a short-lived MCP HTTP endpoint for this user
  • The toolkits array contains "botpress" for Botpress 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 Botpress toolkit
8

Create the Mastra agent

typescript
const agent = new Agent({
    name: "botpress-mastra-agent",
    instructions: "You are an AI agent with Botpress 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: {
        botpress: 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 Botpress 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 Botpress 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: ["botpress"],
  });

  const composioMCPUrl = session.mcp.url;

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

  const composioTools = await mcpClient.getTools();

  const agent = new Agent({
    name: "botpress-mastra-agent",
    instructions: "You are an AI agent with Botpress 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: { botpress: 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 Botpress 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 Botpress action and event your agent gets out of the box.

Break Down Workspace Usage By Bot

Tool to break down workspace usage by bot.

BOTPRESS_CHARGE_WORKSPACE_UNPAID_INVOICES

Tool to charge unpaid invoices for a specific Botpress workspace.

Check Handle Availability

Tool to check if a workspace handle is available in Botpress.

BOTPRESS_CREATE_ADMIN_INTEGRATION

Tool to create a new integration in a Botpress workspace via the Admin API.

BOTPRESS_CREATE_ADMIN_WORKSPACE

Tool to create a new workspace in Botpress via the Admin API.

BOTPRESS_CREATE_BOT

Tool to create a new bot in a Botpress workspace via the Admin API.

BOTPRESS_CREATE_CONVERSATION

Tool to create a new conversation in Botpress via the Runtime API.

Delete Admin Workspace

Tool to permanently delete a workspace from Botpress admin.

Delete File

Permanently deletes a file from a Botpress bot's storage by its file ID.

Delete Integration Shareable ID

Tool to delete a shareable ID for an integration installed in a Botpress bot.

Delete Knowledge Base

Permanently deletes a knowledge base from Botpress by its knowledge base ID.

Get Account

Tool to get details of the authenticated account.

Get Account Preference

Tool to get a preference of the account.

Get All Workspace Quota Completion

Tool to get a map of workspace IDs to their highest quota completion rate.

Get Dereferenced Public Plugin By ID

Tool to get a public plugin by ID with all interface entity references resolved to the corresponding entities as extended by the backing integrations.

Get Integration

Tool to get a specific Botpress integration by name and version.

Get Public Integration

Tool to retrieve a public integration by name and version from the Botpress hub.

Get Public Integration By ID

Tool to retrieve detailed information about a public Botpress integration by its ID.

Get Public Interface

Tool to get a public interface by name and version from the Botpress Hub.

Get Public Interface by ID

Tool to retrieve a public interface by its ID from the Botpress Hub.

Get Public Plugin

Tool to retrieve detailed information about a public plugin from Botpress Hub by name and version.

Get Public Plugin By ID

Tool to retrieve details of a public plugin by its unique ID.

Get Public Plugin Code

Tool to retrieve public plugin code from Botpress Hub.

Get Table Row

Tool to fetch a specific row from a table using the row's unique identifier.

Get Upcoming Invoice

Tool to get the upcoming invoice for a workspace.

Get Workspace

Tool to get detailed information about a specific Botpress workspace by ID.

Get Workspace Quota

Tool to get workspace quota information for a specific usage type.

LIST_ACTION_RUNS

Tool to list action runs for a specific integration of a bot.

LIST_BOT_ISSUES

Tool to list issues associated with a specific bot.

LIST_CONVERSATIONS

Tool to list all Conversations.

LIST_FILE_TAGS

Tool to list all tags used across all bot files.

LIST_FILE_TAG_VALUES

Tool to list all values for a given file tag across all files.

LIST_HUB_INTEGRATIONS

Tool to list public integrations from the Botpress hub.

LIST_INTEGRATION_API_KEYS

Tool to list Integration API Keys (IAKs) for a specific integration.

List Integrations

Tool to list integrations with filtering and sorting capabilities.

LIST_KNOWLEDGE_BASES

Tool to list knowledge bases for a bot.

List Plugins

Tool to list Botpress plugins.

List Public Interfaces

Tool to retrieve a list of public interfaces available in the Botpress Hub.

LIST_PUBLIC_PLUGINS

Tool to retrieve a list of public plugins available in the Botpress hub.

LIST_PUBLIC_WORKSPACES

Tool to retrieve a list of public workspaces.

LIST_USAGE_HISTORY

Tool to retrieve usage history for a bot or workspace.

List Workspace Invoices

Tool to list all invoices billed to a workspace.

LIST_WORKSPACES

List all Botpress workspaces accessible to the authenticated user.

Request Integration Verification

Tool to request verification for a Botpress integration via the Admin API.

BOTPRESS_RUN_VRL

Tool to execute a VRL (Vector Remap Language) script against input data using the Botpress Admin API.

BOTPRESS_SEND_MESSAGE

Tool to send a message to an existing Botpress conversation via the Runtime API.

Set Account Preference

Tool to set a preference for the account.

Set Workspace Preference

Tool to set a preference for a Botpress workspace.

Update Account

Tool to update details of the authenticated account.

BOTPRESS_UPDATE_ADMIN_BOTS

Tool to update an existing bot in a Botpress workspace via the Admin API.

UPDATE_ADMIN_WORKSPACE

Tool to update a Botpress workspace via the Admin API.

BOTPRESS_UPDATE_WORKFLOW

Tool to update a workflow object in Botpress by setting parameter values.

BOTPRESS_VALIDATE_INTEGRATION_UPDATE

Tool to validate an integration update request in Botpress Admin API.

FRAMEWORKS

How to build Botpress MCP Agent with another framework

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Botpress MCP with OpenAI Agents SDK

Claude Agent SDK logo

Claude Agent SDK

Use Botpress MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Botpress MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Botpress MCP with Claude Cowork

Codex logo

Codex

Use Botpress MCP with Codex

OpenClaw logo

OpenClaw

Use Botpress MCP with OpenClaw

Hermes logo

Hermes

Use Botpress MCP with Hermes

CLI logo

CLI

Use Botpress MCP with CLI

Google ADK logo

Google ADK

Use Botpress MCP with Google ADK

LangChain logo

LangChain

Use Botpress MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Botpress MCP with Vercel AI SDK

LlamaIndex logo

LlamaIndex

Use Botpress MCP with LlamaIndex

CrewAI logo

CrewAI

Use Botpress MCP with CrewAI

FAQ

Frequently asked questions

With a standalone Botpress MCP server, the agents and LLMs can only access a fixed set of Botpress tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Botpress 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 Botpress tools.

Yes, absolutely. You can configure which Botpress 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 Botpress data and credentials are handled as safely as possible.

Start with Botpress.It takes 30 seconds.

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

Start building
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

Karan skipped his own birthday party to fix our critical issue. It was 10pm and he diverted his Waymo to help us instead. This really sets the bar — it shows the commitment you need when users rely on your software.

Harsha Gaddipati
Harsha Gaddipati
Co-founder, Slashy

A lot of students tell us that the moment their connected tools start talking to each other inside Opennote feels almost magical. The agent just knows them, and it's immensely helped keep new users on the platform.

Abhi Arya
Abhi Arya
Co-founder, Opennote

We chose Composio over Pipedream because it delivered depth where it mattered — niche tools and tricky edge cases other platforms simply ignored. That gave us confidence to scale without compromising.

Nirman Dave
Nirman Dave
CEO, Zams

As a solo builder, shipping fast is life or death. The only way I can outcompete incumbents is by outmanoeuvring them. Getting bogged down managing agent auth would have been a death sentence.

Ryan Yu
Ryan Yu
Founder, Extra Thursday

Before Composio, adding tool integrations was slow and resource-intensive. Each one could take weeks of engineering time, and maintaining them meant constantly keeping up with API changes.

Tomisin Jenrola
Tomisin Jenrola
Founder & CEO, SwarmZero

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Jerome Leclanche
Jerome Leclanche
Co-Founder, Ingram Technologies