How to integrate Botpress MCP with Claude Code

Trusted by
AWS
Glean
Zoom
Airtable
GET STARTED FOR FREEGET A DEMO

30 min · no commitment · see it on your stack

Botpress logo
Claude Code logo
divider

Introduction

Manage your Botpress directly from Claude Code with zero worries about OAuth hassles, API-breaking issues, or reliability and security concerns.

You can do this in two different ways:

  1. Via Composio Connect - Direct and easiest approach
  2. Via Composio SDK - Programmatic approach with more control

Also integrate Botpress with

Why use Composio?

  • Only one MCP URL to connect multiple apps with Claude Code with zero auth hassles.
  • Programmatic tool calling allows LLMs to write its code in a remote workbench to handle complex tool chaining. Reduces to-and-fro with LLMs for frequent tool calling.
  • Handling Large tool responses out of LLM context to minimize context rot.
  • Dynamic just-in-time access to 20,000 tools across 1000+ other Apps for cross-app workflows. It loads the tools you need, so LLMs aren't overwhelmed by tools you don't need.

Connecting Botpress to Claude Code using Composio

1. Add the Composio MCP to Claude

Terminal

2. Start Claude Code

bash
claude

3. Open your MCP list

bash
/mcp

4. Select Composio and click on Authenticate

Select Composio and click Authenticate

5. This will redirect you to the Composio OAuth page. Complete the flow by authorizing Composio and you're all set.

Composio OAuth authorization page
Composio authorization complete
Ask Claude to connect to your account and authenticate via the link

Supported Tools & Triggers

Tools
Break Down Workspace Usage By BotTool to break down workspace usage by bot.
BOTPRESS_CHARGE_WORKSPACE_UNPAID_INVOICESTool to charge unpaid invoices for a specific Botpress workspace.
Check Handle AvailabilityTool to check if a workspace handle is available in Botpress.
BOTPRESS_CREATE_ADMIN_INTEGRATIONTool to create a new integration in a Botpress workspace via the Admin API.
BOTPRESS_CREATE_ADMIN_WORKSPACETool to create a new workspace in Botpress via the Admin API.
BOTPRESS_CREATE_BOTTool to create a new bot in a Botpress workspace via the Admin API.
BOTPRESS_CREATE_CONVERSATIONTool to create a new conversation in Botpress via the Runtime API.
Delete Admin WorkspaceTool to permanently delete a workspace from Botpress admin.
Delete FilePermanently deletes a file from a Botpress bot's storage by its file ID.
Delete Integration Shareable IDTool to delete a shareable ID for an integration installed in a Botpress bot.
Delete Knowledge BasePermanently deletes a knowledge base from Botpress by its knowledge base ID.
Get AccountTool to get details of the authenticated account.
Get Account PreferenceTool to get a preference of the account.
Get All Workspace Quota CompletionTool to get a map of workspace IDs to their highest quota completion rate.
Get Dereferenced Public Plugin By IDTool to get a public plugin by ID with all interface entity references resolved to the corresponding entities as extended by the backing integrations.
Get IntegrationTool to get a specific Botpress integration by name and version.
Get Public IntegrationTool to retrieve a public integration by name and version from the Botpress hub.
Get Public Integration By IDTool to retrieve detailed information about a public Botpress integration by its ID.
Get Public InterfaceTool to get a public interface by name and version from the Botpress Hub.
Get Public Interface by IDTool to retrieve a public interface by its ID from the Botpress Hub.
Get Public PluginTool to retrieve detailed information about a public plugin from Botpress Hub by name and version.
Get Public Plugin By IDTool to retrieve details of a public plugin by its unique ID.
Get Public Plugin CodeTool to retrieve public plugin code from Botpress Hub.
Get Table RowTool to fetch a specific row from a table using the row's unique identifier.
Get Upcoming InvoiceTool to get the upcoming invoice for a workspace.
Get WorkspaceTool to get detailed information about a specific Botpress workspace by ID.
Get Workspace QuotaTool to get workspace quota information for a specific usage type.
LIST_ACTION_RUNSTool to list action runs for a specific integration of a bot.
LIST_BOT_ISSUESTool to list issues associated with a specific bot.
LIST_CONVERSATIONSTool to list all Conversations.
LIST_FILE_TAGSTool to list all tags used across all bot files.
LIST_FILE_TAG_VALUESTool to list all values for a given file tag across all files.
LIST_HUB_INTEGRATIONSTool to list public integrations from the Botpress hub.
LIST_INTEGRATION_API_KEYSTool to list Integration API Keys (IAKs) for a specific integration.
List IntegrationsTool to list integrations with filtering and sorting capabilities.
LIST_KNOWLEDGE_BASESTool to list knowledge bases for a bot.
List PluginsTool to list Botpress plugins.
List Public InterfacesTool to retrieve a list of public interfaces available in the Botpress Hub.
LIST_PUBLIC_PLUGINSTool to retrieve a list of public plugins available in the Botpress hub.
LIST_PUBLIC_WORKSPACESTool to retrieve a list of public workspaces.
LIST_USAGE_HISTORYTool to retrieve usage history for a bot or workspace.
List Workspace InvoicesTool to list all invoices billed to a workspace.
LIST_WORKSPACESList all Botpress workspaces accessible to the authenticated user.
Request Integration VerificationTool to request verification for a Botpress integration via the Admin API.
BOTPRESS_RUN_VRLTool to execute a VRL (Vector Remap Language) script against input data using the Botpress Admin API.
BOTPRESS_SEND_MESSAGETool to send a message to an existing Botpress conversation via the Runtime API.
Set Account PreferenceTool to set a preference for the account.
Set Workspace PreferenceTool to set a preference for a Botpress workspace.
Update AccountTool to update details of the authenticated account.
BOTPRESS_UPDATE_ADMIN_BOTSTool to update an existing bot in a Botpress workspace via the Admin API.
UPDATE_ADMIN_WORKSPACETool to update a Botpress workspace via the Admin API.
BOTPRESS_UPDATE_WORKFLOWTool to update a workflow object in Botpress by setting parameter values.
BOTPRESS_VALIDATE_INTEGRATION_UPDATETool to validate an integration update request in Botpress Admin API.

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.

Connecting Botpress via Composio SDK

Composio SDK is the underlying tech that powers Rube. It's a universal gateway that does everything Rube does but with much more programmatic control. You can programmatically generate an MCP URL with the app you need (here Botpress) for even more tool search precision. It's secure and reliable.

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

Prerequisites

Before starting, make sure you have:
  • Claude Pro, Max, or API billing enabled Anthropic account
  • Composio API Key
  • A Botpress account
  • Basic knowledge of Python or TypeScript

Install Claude Code

bash
# macOS, Linux, WSL
curl -fsSL https://claude.ai/install.sh | bash

# Windows PowerShell
irm https://claude.ai/install.ps1 | iex

# Windows CMD
curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

To install Claude Code, use one of the following methods based on your operating system:

Set up Claude Code

bash
cd your-project-folder
claude

Open a terminal, go to your project folder, and start Claude Code:

  • Claude Code will open in your terminal
  • Follow the prompts to sign in with your Anthropic account
  • Complete the authentication flow
  • Once authenticated, you can start using Claude Code
Claude Code initial setup showing sign-in prompt
Claude Code terminal after successful login

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here

Create a .env file in your project root with the following variables:

  • COMPOSIO_API_KEY authenticates with Composio (get it from Composio dashboard)
  • USER_ID identifies the user for session management (use any unique identifier)

Install Composio library

pip install composio-core python-dotenv

Install the Composio Python library to create MCP sessions.

  • composio-core provides the core Composio functionality
  • python-dotenv loads environment variables from your .env file

Generate Composio MCP URL

import os
from composio import Composio
from dotenv import load_dotenv

load_dotenv()

COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
USER_ID = os.getenv("USER_ID")

composio_client = Composio(api_key=COMPOSIO_API_KEY)

composio_session = composio_client.create(
    user_id=USER_ID,
    toolkits=["botpress"],
)

COMPOSIO_MCP_URL = composio_session.mcp.url

print(f"MCP URL: {COMPOSIO_MCP_URL}")
print(f"\nUse this command to add to Claude Code:")
print(f'claude mcp add --transport http botpress-composio "{COMPOSIO_MCP_URL}" --headers "X-API-Key:{COMPOSIO_API_KEY}"')

Create a script to generate a Composio MCP URL for Botpress. This URL will be used to connect Claude Code to Botpress.

What's happening:
  • We import the Composio client and load environment variables
  • Create a Composio instance with your API key
  • Call create() to create a Tool Router session for Botpress
  • The returned mcp.url is the MCP server URL that Claude Code will use
  • The script prints this URL so you can copy it

Run the script and copy the MCP URL

python generate_mcp_url.py

Run your Python script to generate the MCP URL.

  • The script connects to Composio and creates a Tool Router session
  • It prints the MCP URL and the exact command you need to run
  • Copy the entire claude mcp add command from the output

Add Botpress MCP to Claude Code

bash
claude mcp add --transport http botpress-composio "YOUR_MCP_URL_HERE" --headers "X-API-Key:YOUR_COMPOSIO_API_KEY"

# Then restart Claude Code
exit
claude

In your terminal, add the MCP server using the command from the previous step. The command format is:

  • claude mcp add registers a new MCP server with Claude Code
  • --transport http specifies that this is an HTTP-based MCP server
  • The server name (botpress-composio) is how you'll reference it
  • The URL points to your Composio Tool Router session
  • --headers includes your Composio API key for authentication

After running the command, close the current Claude Code session and start a new one for the changes to take effect.

Verify the installation

bash
claude mcp list

Check that your Botpress MCP server is properly configured.

  • This command lists all MCP servers registered with Claude Code
  • You should see your botpress-composio entry in the list
  • This confirms that Claude Code can now access Botpress tools

If everything is wired up, you should see your botpress-composio entry listed:

Claude Code MCP list showing the toolkit MCP server

Authenticate Botpress

The first time you try to use Botpress tools, you'll be prompted to authenticate.

  • Claude Code will detect that you need to authenticate with Botpress
  • It will show you an authentication link
  • Open the link in your browser (or copy/paste it)
  • Complete the Botpress authorization flow
  • Return to the terminal and start using Botpress through Claude Code

Once authenticated, you can ask Claude Code to perform Botpress operations in natural language. For example:

  • "List all active conversations for my bot"
  • "Show issues reported for a specific bot"
  • "Delete a file from a bot workspace"

Complete Code

Here's the complete code to get you started with Botpress and Claude Code:

import os
from composio import Composio
from dotenv import load_dotenv

load_dotenv()

COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
USER_ID = os.getenv("USER_ID")

composio_client = Composio(api_key=COMPOSIO_API_KEY)

composio_session = composio_client.create(
    user_id=USER_ID,
    toolkits=["botpress"],
)

COMPOSIO_MCP_URL = composio_session.mcp.url

print(f"MCP URL: {COMPOSIO_MCP_URL}")
print(f"\nUse this command to add to Claude Code:")
print(f'claude mcp add --transport http botpress-composio "{COMPOSIO_MCP_URL}" --headers "X-API-Key:{COMPOSIO_API_KEY}"')

Conclusion

You've successfully integrated Botpress with Claude Code using Composio's MCP server. Now you can interact with Botpress directly from your terminal using natural language commands.

Key features of this setup:

  • Terminal-native experience without switching contexts
  • Natural language commands for Botpress operations
  • Secure authentication through Composio's managed MCP
  • Tool Router for dynamic tool discovery and execution

Next steps:

  • Try asking Claude Code to perform various Botpress operations
  • Add more toolkits to your Tool Router session for multi-app workflows
  • Integrate this setup into your development workflow for increased productivity

You can extend this by adding more toolkits, implementing custom workflows, or building automation scripts that leverage Claude Code's capabilities.

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

What are the differences in Tool Router MCP and Botpress MCP?

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.

Can I use Tool Router MCP with Claude Code?

Yes, you can. Claude Code 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.

Can I manage the permissions and scopes for Botpress while using Tool Router?

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.

How safe is my data with Composio Tool Router?

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.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Get started for freeGet a demo↗