Read bots, logs, analytics, conversations, messages, tables and files in Botpress. For teams that build and run chatbots in Botpress. Hosted by usefulapi — connect from Claude, ChatGPT, Cursor, or any MCP client.
Team and Enterprise: an Owner adds the connector for the organization first.
Run this command, then run /mcp in Claude Code to log in:
Add to Cursor or add this to ~/.cursor/mcp.json:
{
"mcpServers": {
"botpress": {
"url": "https://botpress.usefulapi.io/mcp"
}
}
}Add to VS Code or add this to .vscode/mcp.json:
{
"servers": {
"botpress": {
"type": "http",
"url": "https://botpress.usefulapi.io/mcp"
}
}
}No Add custom MCP server option? It depends on your account or workspace settings: see OpenAI's guide.
Run these commands. The second one opens the login page:
Other MCP clients (Windsurf, Cline, Zed and more): add the URL as a remote MCP server (Streamable HTTP). The client then opens the login page in your browser. Do not add an Authorization header: see Before you connect.
Read the logs, the issues and the analytics of a bot. Look for errors after a new release.
botpress_get_bot_logs botpress_list_bot_issues botpress_get_bot_analytics
List the conversations of a bot and read the messages of one. Use it to see where the bot failed.
botpress_list_conversations botpress_get_conversation botpress_list_messages
List the tables of a bot and find rows that match a filter.
botpress_list_tables botpress_get_table botpress_find_table_rows
Search the files of a bot for matching passages and read the details of a file. Use it to check what the bot knows.
botpress_search_files botpress_list_files botpress_get_file
List the workspaces, the members and the bots of an account.
botpress_list_workspaces botpress_list_workspace_members botpress_list_bots
The login page asks for your Personal Access Token and Workspace id.
Create the token in Botpress → Profile settings → Personal Access Tokens. Find the workspace id in your workspace settings (or the URL of the workspace). The token has the same access as your user. It is used only to call the API on your behalf and to derive a private account id.
Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your Personal Access Token and Workspace id. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
Turn on the Botpress connector, then ask in plain words. The AI picks the tools.
| Tool | Type | What it does |
|---|---|---|
botpress_get_account | read | Get account Show the Botpress account that owns the token (id, email, display name). Admin API: GET /v1/admin/account/me. |
botpress_list_workspaces | read | List workspaces List the workspaces the token's user can access, with plan, bot count and spending limit. Admin API: GET /v1/admin/workspaces. |
botpress_list_workspace_members | read | List workspace members List the members of the connected workspace with their role and email. Admin API: GET /v1/admin/workspace-members. |
botpress_list_bots | read | List bots List the bots of the connected workspace (id, name, type, deploy time). Good first call: the other tools need a bot id. Admin API: GET /v1/admin/bots. |
botpress_get_bot | read | Get bot Get one bot: name, type, deploy time, tags and the enabled state of its integrations. The signing secret and integration configuration are left out on purpose. Admin API: GET /v1/admin/bots/{id}. |
botpress_get_bot_logs | read | Get bot logs Read the logs of a bot in a time range, with filters for level, user, conversation and message text. Admin API: GET /v1/admin/bots/{id}/logs. |
botpress_get_bot_analytics | read | Get bot analytics Get usage analytics of a bot per period: users, sessions, messages, events and LLM calls, tokens and cost. Admin API: GET /v1/admin/bots/{id}/analytics. |
botpress_list_bot_issues | read | List bot issues List the grouped runtime issues (errors) of a bot with counts and last-seen time. Admin API: GET /v1/admin/bots/{id}/issues. |
botpress_list_conversations | read | List conversations List the conversations of a bot, with channel, integration and message count. Filter by date, channel or participant. Runtime API: GET /v1/chat/conversations. |
botpress_get_conversation | read | Get conversation Get one conversation of a bot by id. Runtime API: GET /v1/chat/conversations/{id}. |
botpress_list_messages | read | List messages List the messages of a bot, for one conversation or for a date range. Runtime API: GET /v1/chat/messages. |
botpress_list_users | read | List users List the end users who talked to a bot. Filter by conversation or date. Runtime API: GET /v1/chat/users. |
botpress_get_user | read | Get user Get one end user of a bot by id. Runtime API: GET /v1/chat/users/{id}. |
botpress_list_tables | read | List tables List the Tables of a bot with their schema. Tables API: GET /v1/tables. |
botpress_get_table | read | Get table Get one Table with its schema, row count and indexing state. Tables API: GET /v1/tables/{table}. |
botpress_find_table_rows | read | Find table rows Read rows of a Table with an optional MongoDB-like filter, text search, column selection and sorting. Read only. Tables API: POST /v1/tables/{table}/rows/find. |
botpress_list_files | read | List files List the files in the knowledge base of a bot (key, size, type, indexing status). Files API: GET /v1/files. |
botpress_get_file | read | Get file Get the metadata of one file of a bot, by id or key. Files API: GET /v1/files/{id}. |
botpress_search_files | read | Search files Semantic search over the indexed files of a bot. Returns the best matching text passages. Files API: GET /v1/files/search. |
botpress_usage_status | Usage status (free-tier meter) Report the caller's current usage: the plan, calls used this month, the limit of the plan (the free monthly cap or the Pro fair use limit), remaining, and whether the limit is reached. Read-only; does not count against the meter. | |
botpress_request_feature | Request a missing feature Tell usefulapi that the user needs something the Botpress tools cannot do yet (a missing tool, field or filter). Call it only when the user asks for something none of the tools can do, and tell the user that you send the request. Do not call it for errors or for normal requests. Do not include personal data, credentials or customer records. Stored with the product name and the client type (for example Claude or Cursor), without the user's account. At most 5 requests per day. Does not count against the meter. | |
botpress_upgrade | Upgrade to Pro (unlimited*) Get Pro: unlimited tool calls (fair use limit: 10,000 a month) on Botpress (the free tier caps monthly usage). Plans: "monthly" — $9/month; "yearly" — $90/year (2 months free). Cancel any time: Pro then runs to the end of the paid period, so it also suits a one-time job. *A fair use limit applies. For heavy use (near Pro's limit): "plus" or "plus_yearly" — Pro+, $39/month or $390/year, unlimited tool calls (fair use limit: 100,000 a month); an existing Pro subscription changes to Pro+ in place (needs confirm: true; the price difference for the rest of the period is charged at once). Otherwise returns a short link to open in your browser (it opens Stripe Checkout); after payment the account upgrades automatically. Does not count against the meter. | |
botpress_cancel_subscription | Cancel the Pro subscription Cancel the caller's Botpress Pro subscription at the end of the paid period (no refund for the current period; Pro continues until then, then the free tier applies). Requires confirm: true. Run botpress_upgrade later to undo the cancel before the period ends. Does not count against the meter. |
| Plan | Price | Limit |
|---|---|---|
| Free | $0 | 50 tool calls / month |
| Proper user | $9/mo · $90/yr | Unlimited* |
*Pro fair use limit: 10,000 tool calls a month on this server. For more, write to [email protected].
Pro covers this Botpress server only. Subscribe with botpress_upgrade (it returns a Stripe Checkout link). Cancel any time with botpress_cancel_subscription: Pro continues to the end of the paid period, with no refund for the current period, and running botpress_upgrade before then undoes the cancel. Or write to [email protected].
Check the health of a bot. Read a customer conversation. Look up the rows of a bot table. Search the knowledge base files. See who has access to a workspace. See what you can do for the details.
No. usefulapi is an independent service. It is not affiliated with or endorsed by Botpress. The server calls the Botpress API with your own Botpress access, so it sees only the data that your account can see.
Yes. In Claude, add this server's URL as a custom connector. In ChatGPT, add it as a custom MCP server in Plugins. Then log in once. Cursor, VS Code, Claude Code and Codex work too. See the setup steps.
The login page asks for your Personal Access Token and Workspace id. See Before you connect for where to find them.
No. Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your Personal Access Token and Workspace id. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
The login stores them encrypted in the authorization grant of your connection. The server uses them to call the Botpress API for you and to derive a private account id for usage metering. usefulapi does not show them on any page or in any reply. To stop all access, remove the connector and change or delete these credentials in Botpress.
All 19 Botpress tools are marked read-only.
The Free plan gives 50 tool calls / month. Pro costs $9/mo or $90/yr, with unlimited tool calls (fair use limit: 10,000 tool calls a month), for this Botpress server only. Cancel any time: Pro then runs to the end of the paid period. Run botpress_usage_status to see how many calls you used.
Ask the AI to run botpress_upgrade: it returns a Stripe Checkout link. To cancel, run botpress_cancel_subscription. Pro continues to the end of the paid period.
Tell the AI what you wanted to do. It can send the request with botpress_request_feature. We store the text with the server name, the type of AI client and the tool you tried, not with your account, and read every request when we plan new tools. You can send up to 5 requests per day.
Any client that supports remote MCP servers (Streamable HTTP) with OAuth login: Claude (web and desktop), Claude Code, ChatGPT, Codex, Cursor, VS Code, Windsurf and others.
This is a Model Context Protocol endpoint — meant to be connected from an AI client, not opened in a browser. An invalid_token response at the URL is the auth gate working as designed; clients authenticate automatically.
Need a tool this server does not have, or a connection to another system? We build custom integrations and MCP servers.