How to integrate Botpress MCP with OpenAI Agents SDK

This guide walks you through connecting Botpress to the OpenAI Agents SDK 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 OpenAI Agents SDK 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 the OpenAI Agents SDK 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 OpenAI Agents SDK 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

Claude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

TL;DR

Here's what you'll learn:
  • Get and set up your OpenAI and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Botpress
  • Configure an AI agent that can use Botpress as a tool
  • Run a live chat session where you can ask the agent to perform Botpress operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

  • Hosted MCP Tools: Connect to external services through hosted MCP endpoints
  • SQLite Sessions: Persist conversation history across interactions
  • Simple API: Clean interface with Agent, Runner, and tool configuration
  • Streaming Support: Real-time response streaming for interactive applications

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:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Botpress project
  • Some knowledge of Python or Typescript
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
  • Keep the API key safe.
Composio API Key
3

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

4

Set up environment variables

bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

5

Import dependencies

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';
What's happening:
  • You're importing all necessary libraries.
  • The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Botpress.
6

Set up the Composio instance

dotenv.config();

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});
What's happening:
  • dotenv.config() loads your .env file so COMPOSIO_API_KEY and USER_ID are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.
7

Create a Tool Router session

// Create Tool Router session for Botpress
const session = await composio.create(userId as string, {
  toolkits: ['botpress'],
});
const mcpUrl = session.mcp.url;

What is happening:

  • You give the Tool Router the user id and the toolkits you want available. Here, it is only botpress.
  • The router checks the user's Botpress connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Botpress.
  • This approach keeps things lightweight and lets the agent request Botpress tools only when needed during the conversation.
8

Configure the agent

// Configure agent with MCP tool
const agent = new Agent({
  name: 'Assistant',
  model: 'gpt-5',
  instructions:
    'You are a helpful assistant that can access Botpress. Help users perform Botpress operations through natural language.',
  tools: [
    hostedMcpTool({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: 'never',
    }),
  ],
});
What's happening:
  • We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
  • The agent's instructions tell it that it can access Botpress and help with queries, inserts, updates, authentication, and fetching database information.
  • The tools array includes a hostedMcpTool that connects to the MCP server URL we created earlier.
  • The headers object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute Botpress operations without asking for permission each time, making interactions smoother.
9

Start chat loop and handle conversation

// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

// Simple CLI
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: 'You: ',
});

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

rl.on('line', async (userInput) => {
  const text = userInput.trim();

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

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

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});
What's happening:
  • The program prints a session URL that you visit to authorize Botpress.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using run().
  • The responses are printed to the console.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Botpress and OpenAI Agents SDK:

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['botpress'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new Agent({
    name: 'Assistant',
    model: 'gpt-5',
    instructions:
      'You are a helpful assistant that can access Botpress. Help users perform Botpress operations through natural language.',
    tools: [
      hostedMcpTool({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

  // Simple CLI
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: ',
  });

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

  rl.on('line', async (userInput) => {
    const text = userInput.trim();

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

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

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\n');
    }

    rl.prompt();
  });

  rl.on('close', () => {
    console.log('\nSession ended.');
    process.exit(0);
  });
}

main().catch((err) => {
  console.error('Fatal error:', err);
  process.exit(1);
});

Conclusion

This was a starter code for integrating Botpress MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Botpress.

Key features:

  • Hosted MCP tool integration through Composio's Tool Router
  • SQLite session persistence for conversation history
  • Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.
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

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

Mastra AI logo

Mastra AI

Use Botpress MCP with Mastra AI

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. OpenAI Agents SDK 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