Skip to content
MCP server

Botpress MCP by usefulapi

Read bots, logs, analytics, conversations, messages, tables and files in Botpress.

Install
Runs
Remotely
Version
1.8.0
Listing updated
4 days ago

About Botpress MCP by usefulapi

Botpress MCP by usefulapi is an MCP server. It runs as a hosted remote server, so there is nothing to install locally.

Install

Run in a terminal

claude mcp add --transport http botpress https://botpress.usefulapi.io/mcp

Add to Settings → Connectors → Add custom connector

https://botpress.usefulapi.io/mcp
Install in CursorOpens Cursor, which asks you to confirm. Or add it by hand:

Add to ~/.cursor/mcp.json

{
  "mcpServers": {
    "botpress": {
      "url": "https://botpress.usefulapi.io/mcp"
    }
  }
}
Install in VS CodeOpens VS Code, which asks you to confirm. Or add it by hand:

Add to .vscode/mcp.json

{
  "servers": {
    "botpress": {
      "type": "http",
      "url": "https://botpress.usefulapi.io/mcp"
    }
  }
}

Add to ~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "botpress": {
      "serverUrl": "https://botpress.usefulapi.io/mcp"
    }
  }
}

Add to your client's MCP settings (most use this shape)

{
  "mcpServers": {
    "botpress": {
      "type": "http",
      "url": "https://botpress.usefulapi.io/mcp"
    }
  }
}

Tools this server provides (23)

Read directly from the server.

botpress_get_account
Show the Botpress account that owns the token (id, email, display name). Admin API: GET /v1/admin/account/me.
botpress_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
List the members of the connected workspace with their role and email. Admin API: GET /v1/admin/workspace-members.
botpress_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
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 bot logs with level, user, conversation and message filters. Use real ISO 8601 timestamps with a timezone; times are normalized to UTC and timeStart must not be later than timeEnd. Admin API: GET /v1/admin/bots/{id}/logs.
botpress_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
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
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
Get one conversation of a bot by id. Runtime API: GET /v1/chat/conversations/{id}.
botpress_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
List the end users who talked to a bot. Filter by conversation or date. Runtime API: GET /v1/chat/users.
botpress_get_user
Get one end user of a bot by id. Runtime API: GET /v1/chat/users/{id}.
botpress_list_tables
List the Tables of a bot with their schema. Tables API: GET /v1/tables.
botpress_get_table
Get one Table with its schema, row count and indexing state. Tables API: GET /v1/tables/{table}.
botpress_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
List the files in the knowledge base of a bot (key, size, type, indexing status). Files API: GET /v1/files.
botpress_get_file
Get the metadata of one file of a bot, by id or key. Files API: GET /v1/files/{id}.
botpress_search_files
Semantic search over the indexed files of a bot. Returns the best matching text passages. Files API: GET /v1/files/search.
botpress_get_bot_content
Inspect authenticated Studio bot JSON in bounded pages. Returns a snapshot_hash and observed JSON Pointer paths; follow paths to inspect workflow/instruction strings. Credential fields are omitted. Does not change or publish anything. API: official SDK getBotJson.
botpress_preview_bot_content_edit
Read-only local preview/validation of existing workflow or instruction text replacements against a fresh snapshot_hash. Returns before/after changes and preview_hash for user approval. No draft save, vendor compile validation or publish occurs. Only observed string paths may be edited; structure/IDs/settings/credentials cannot be changed.
botpress_publish_bot_content_edit
WRITE: publish exactly the approved text edits to the live Studio bot using official SDK publishFromBotJson. Obtain user approval first. Requires confirm:true, snapshot_hash, exact preview_hash and stable operation_id. Rechecks current content, preserves all unedited data and prevents replay after uncertain publication. No atomic vendor conditional write: avoid simultaneous Studio edits. Hosted pe
botpress_get_content_operation
Read the persistent result of a content publish in this authenticated workspace and bot. An uncertain outcome must be reconciled in Studio; never retry it with a new operation_id.

Botpress MCP by usefulapi FAQ

How do I add Botpress MCP by usefulapi to Claude Code?

Run this command in your terminal: claude mcp add --transport http botpress https://botpress.usefulapi.io/mcp