Botpress MCP by usefulapi is an MCP server published by io.usefulapi, hosted at botpress.usefulapi.io. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 23 tools, including botpress_get_account, botpress_list_workspaces, botpress_list_workspace_members, botpress_list_bots, botpress_get_bot.
Read bots, logs, analytics, conversations, messages, tables and files in Botpress.
4,102 connections through 5 shared values. Tap any node.
Inferred from the host name and headers: what a server runs on, not who runs it.
Show the Botpress account that owns the token (id, email, display name). Admin API: GET /v1/admin/account/me.
No parameters.
{
"name": "botpress_get_account",
"title": "Get account",
"description": "Show the Botpress account that owns the token (id, email, display name). Admin API: GET /v1/admin/account/me.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Get account",
"readOnlyHint": true
}
}List the workspaces the token's user can access, with plan, bot count and spending limit. Admin API: GET /v1/admin/workspaces.
None yet. Changes appear after a server's second daily check.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
| Parameter | Type | Description |
|---|---|---|
| handle | string | Filter by workspace handle. |
| nextToken | string | Pagination cursor: the meta.nextToken value from the previous response. |
{
"name": "botpress_list_workspaces",
"title": "List workspaces",
"description": "List the workspaces the token's user can access, with plan, bot count and spending limit. Admin API: GET /v1/admin/workspaces.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"handle": {
"type": "string",
"description": "Filter by workspace handle."
},
"nextToken": {
"type": "string",
"description": "Pagination cursor: the meta.nextToken value from the previous response."
}
}
},
"annotations": {
"title": "List workspaces",
"readOnlyHint": true
}
}List the members of the connected workspace with their role and email. Admin API: GET /v1/admin/workspace-members.
| Parameter | Type | Description |
|---|---|---|
| nextToken | string | Pagination cursor: the meta.nextToken value from the previous response. |
{
"name": "botpress_list_workspace_members",
"title": "List workspace members",
"description": "List the members of the connected workspace with their role and email. Admin API: GET /v1/admin/workspace-members.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"nextToken": {
"type": "string",
"description": "Pagination cursor: the meta.nextToken value from the previous response."
}
}
},
"annotations": {
"title": "List workspace members",
"readOnlyHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| dev | boolean | If true, list only dev bots. Default: production bots. |
| nextToken | string | Pagination cursor: the meta.nextToken value from the previous response. |
| sortField | string | one of ["createdAt","updatedAt"] |
| sortDirection | string | Sort direction. |
{
"name": "botpress_list_bots",
"title": "List bots",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"dev": {
"type": "boolean",
"description": "If true, list only dev bots. Default: production bots."
},
"nextToken": {
"type": "string",
"description": "Pagination cursor: the meta.nextToken value from the previous response."
},
"sortField": {
"enum": [
"createdAt",
"updatedAt"
],
"type": "string"
},
"sortDirection": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
}
}
},
"annotations": {
"title": "List bots",
"readOnlyHint": true
}
}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}.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | Bot id (from botpress_list_bots). |
{
"name": "botpress_get_bot",
"title": "Get bot",
"description": "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}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id"
],
"properties": {
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
}
}
},
"annotations": {
"title": "Get bot",
"readOnlyHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| level | string | Filter by log level. |
| bot_id * | string | Bot id (from botpress_list_bots). |
| userId | string | |
| timeEnd | string | End of the time range, ISO 8601 with a timezone. |
| nextToken | string | Pagination cursor: the top-level nextToken value from the previous response. |
| timeStart * | string | Start of the time range, ISO 8601 with a timezone (for example 2026-11-01T00:00:00Z). |
| workflowId | string | |
| conversationId | string | |
| messageContains | string | Keep logs whose message contains this text. |
{
"name": "botpress_get_bot_logs",
"title": "Get bot logs",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"timeStart"
],
"properties": {
"level": {
"type": "string",
"description": "Filter by log level."
},
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"userId": {
"type": "string"
},
"timeEnd": {
"type": "string",
"description": "End of the time range, ISO 8601 with a timezone."
},
"nextToken": {
"type": "string",
"description": "Pagination cursor: the top-level nextToken value from the previous response."
},
"timeStart": {
"type": "string",
"description": "Start of the time range, ISO 8601 with a timezone (for example 2026-11-01T00:00:00Z)."
},
"workflowId": {
"type": "string"
},
"conversationId": {
"type": "string"
},
"messageContains": {
"type": "string",
"description": "Keep logs whose message contains this text."
}
}
},
"annotations": {
"title": "Get bot logs",
"readOnlyHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | Bot id (from botpress_list_bots). |
| endDate * | string | End date/time, inclusive, ISO 8601. |
| startDate * | string | Start date/time, inclusive, ISO 8601. |
{
"name": "botpress_get_bot_analytics",
"title": "Get bot analytics",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"startDate",
"endDate"
],
"properties": {
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"endDate": {
"type": "string",
"description": "End date/time, inclusive, ISO 8601."
},
"startDate": {
"type": "string",
"description": "Start date/time, inclusive, ISO 8601."
}
}
},
"annotations": {
"title": "Get bot analytics",
"readOnlyHint": true
}
}List the grouped runtime issues (errors) of a bot with counts and last-seen time. Admin API: GET /v1/admin/bots/{id}/issues.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | Bot id (from botpress_list_bots). |
| nextToken | string | Pagination cursor: the meta.nextToken value from the previous response. |
{
"name": "botpress_list_bot_issues",
"title": "List bot issues",
"description": "List the grouped runtime issues (errors) of a bot with counts and last-seen time. Admin API: GET /v1/admin/bots/{id}/issues.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id"
],
"properties": {
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"nextToken": {
"type": "string",
"description": "Pagination cursor: the meta.nextToken value from the previous response."
}
}
},
"annotations": {
"title": "List bot issues",
"readOnlyHint": true
}
}List the conversations of a bot, with channel, integration and message count. Filter by date, channel or participant. Runtime API: GET /v1/chat/conversations.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | Bot id (from botpress_list_bots). |
| channel | string | Filter by integration channel name. |
| afterDate | string | Created on or after this ISO 8601 UTC date. |
| nextToken | string | Pagination cursor: the meta.nextToken value from the previous response. |
| sortField | string | one of ["createdAt","updatedAt"] |
| beforeDate | string | Created on or before this ISO 8601 UTC date. |
| participantId | string | Only conversations with this participant (user id). |
| sortDirection | string | Sort direction. |
| integrationName | string | Filter by integration name. |
{
"name": "botpress_list_conversations",
"title": "List conversations",
"description": "List the conversations of a bot, with channel, integration and message count. Filter by date, channel or participant. Runtime API: GET /v1/chat/conversations.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id"
],
"properties": {
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"channel": {
"type": "string",
"description": "Filter by integration channel name."
},
"afterDate": {
"type": "string",
"description": "Created on or after this ISO 8601 UTC date."
},
"nextToken": {
"type": "string",
"description": "Pagination cursor: the meta.nextToken value from the previous response."
},
"sortField": {
"enum": [
"createdAt",
"updatedAt"
],
"type": "string"
},
"beforeDate": {
"type": "string",
"description": "Created on or before this ISO 8601 UTC date."
},
"participantId": {
"type": "string",
"description": "Only conversations with this participant (user id)."
},
"sortDirection": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"integrationName": {
"type": "string",
"description": "Filter by integration name."
}
}
},
"annotations": {
"title": "List conversations",
"readOnlyHint": true
}
}Get one conversation of a bot by id. Runtime API: GET /v1/chat/conversations/{id}.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | Bot id (from botpress_list_bots). |
| conversation_id * | string | Conversation id. |
{
"name": "botpress_get_conversation",
"title": "Get conversation",
"description": "Get one conversation of a bot by id. Runtime API: GET /v1/chat/conversations/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"conversation_id"
],
"properties": {
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"conversation_id": {
"type": "string",
"description": "Conversation id."
}
}
},
"annotations": {
"title": "Get conversation",
"readOnlyHint": true
}
}List the messages of a bot, for one conversation or for a date range. Runtime API: GET /v1/chat/messages.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | Bot id (from botpress_list_bots). |
| afterDate | string | Created on or after this ISO 8601 UTC date. |
| nextToken | string | Pagination cursor: the meta.nextToken value from the previous response. |
| beforeDate | string | Created on or before this ISO 8601 UTC date. |
| conversationId | string | Only messages of this conversation. |
{
"name": "botpress_list_messages",
"title": "List messages",
"description": "List the messages of a bot, for one conversation or for a date range. Runtime API: GET /v1/chat/messages.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id"
],
"properties": {
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"afterDate": {
"type": "string",
"description": "Created on or after this ISO 8601 UTC date."
},
"nextToken": {
"type": "string",
"description": "Pagination cursor: the meta.nextToken value from the previous response."
},
"beforeDate": {
"type": "string",
"description": "Created on or before this ISO 8601 UTC date."
},
"conversationId": {
"type": "string",
"description": "Only messages of this conversation."
}
}
},
"annotations": {
"title": "List messages",
"readOnlyHint": true
}
}List the end users who talked to a bot. Filter by conversation or date. Runtime API: GET /v1/chat/users.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | Bot id (from botpress_list_bots). |
| afterDate | string | ISO 8601 UTC date, inclusive. |
| nextToken | string | Pagination cursor: the meta.nextToken value from the previous response. |
| sortField | string | one of ["createdAt","updatedAt"] |
| beforeDate | string | ISO 8601 UTC date, inclusive. |
| rangeField | string | Field the date range applies to (default createdAt). |
| sortDirection | string | Sort direction. |
| conversationId | string | Only users of this conversation. |
{
"name": "botpress_list_users",
"title": "List users",
"description": "List the end users who talked to a bot. Filter by conversation or date. Runtime API: GET /v1/chat/users.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id"
],
"properties": {
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"afterDate": {
"type": "string",
"description": "ISO 8601 UTC date, inclusive."
},
"nextToken": {
"type": "string",
"description": "Pagination cursor: the meta.nextToken value from the previous response."
},
"sortField": {
"enum": [
"createdAt",
"updatedAt"
],
"type": "string"
},
"beforeDate": {
"type": "string",
"description": "ISO 8601 UTC date, inclusive."
},
"rangeField": {
"enum": [
"createdAt",
"updatedAt"
],
"type": "string",
"description": "Field the date range applies to (default createdAt)."
},
"sortDirection": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"conversationId": {
"type": "string",
"description": "Only users of this conversation."
}
}
},
"annotations": {
"title": "List users",
"readOnlyHint": true
}
}Get one end user of a bot by id. Runtime API: GET /v1/chat/users/{id}.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | Bot id (from botpress_list_bots). |
| user_id * | string | User id. |
{
"name": "botpress_get_user",
"title": "Get user",
"description": "Get one end user of a bot by id. Runtime API: GET /v1/chat/users/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"user_id"
],
"properties": {
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"user_id": {
"type": "string",
"description": "User id."
}
}
},
"annotations": {
"title": "Get user",
"readOnlyHint": true
}
}List the Tables of a bot with their schema. Tables API: GET /v1/tables.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | Bot id (from botpress_list_bots). |
{
"name": "botpress_list_tables",
"title": "List tables",
"description": "List the Tables of a bot with their schema. Tables API: GET /v1/tables.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id"
],
"properties": {
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
}
}
},
"annotations": {
"title": "List tables",
"readOnlyHint": true
}
}Get one Table with its schema, row count and indexing state. Tables API: GET /v1/tables/{table}.
| Parameter | Type | Description |
|---|---|---|
| table * | string | Table name or id. |
| bot_id * | string | Bot id (from botpress_list_bots). |
{
"name": "botpress_get_table",
"title": "Get table",
"description": "Get one Table with its schema, row count and indexing state. Tables API: GET /v1/tables/{table}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"table"
],
"properties": {
"table": {
"type": "string",
"description": "Table name or id."
},
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
}
}
},
"annotations": {
"title": "Get table",
"readOnlyHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Rows per page (default 100). |
| table * | string | Table name or id. |
| bot_id * | string | Bot id (from botpress_list_bots). |
| filter | object | MongoDB-like filter, for example {"name":{"$eq":"John"}}. |
| offset | integer | Rows to skip. |
| search | string | Text search term. |
| select | array | Columns to return (dot notation for nested). |
| orderBy | string | Column to sort by (default id). |
| orderDirection | string | Sort direction. |
{
"name": "botpress_find_table_rows",
"title": "Find table rows",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"table"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Rows per page (default 100)."
},
"table": {
"type": "string",
"description": "Table name or id."
},
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"filter": {
"type": "object",
"description": "MongoDB-like filter, for example {\"name\":{\"$eq\":\"John\"}}.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Rows to skip."
},
"search": {
"type": "string",
"maxLength": 1024,
"description": "Text search term."
},
"select": {
"type": "array",
"items": {
"type": "string"
},
"description": "Columns to return (dot notation for nested)."
},
"orderBy": {
"type": "string",
"description": "Column to sort by (default id)."
},
"orderDirection": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
}
}
},
"annotations": {
"title": "Find table rows",
"readOnlyHint": true
}
}List the files in the knowledge base of a bot (key, size, type, indexing status). Files API: GET /v1/files.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | Bot id (from botpress_list_bots). |
| indexed | boolean | Filter by indexing state. |
| nextToken | string | Pagination cursor: the meta.nextToken value from the previous response. |
| sortField | string | one of ["key","size","createdAt","updatedAt","status"] |
| sortDirection | string | Sort direction. |
{
"name": "botpress_list_files",
"title": "List files",
"description": "List the files in the knowledge base of a bot (key, size, type, indexing status). Files API: GET /v1/files.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id"
],
"properties": {
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"indexed": {
"type": "boolean",
"description": "Filter by indexing state."
},
"nextToken": {
"type": "string",
"description": "Pagination cursor: the meta.nextToken value from the previous response."
},
"sortField": {
"enum": [
"key",
"size",
"createdAt",
"updatedAt",
"status"
],
"type": "string"
},
"sortDirection": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
}
}
},
"annotations": {
"title": "List files",
"readOnlyHint": true
}
}Get the metadata of one file of a bot, by id or key. Files API: GET /v1/files/{id}.
| Parameter | Type | Description |
|---|---|---|
| file * | string | File id or key. |
| bot_id * | string | Bot id (from botpress_list_bots). |
{
"name": "botpress_get_file",
"title": "Get file",
"description": "Get the metadata of one file of a bot, by id or key. Files API: GET /v1/files/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"file"
],
"properties": {
"file": {
"type": "string",
"description": "File id or key."
},
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
}
}
},
"annotations": {
"title": "Get file",
"readOnlyHint": true
}
}Semantic search over the indexed files of a bot. Returns the best matching text passages. Files API: GET /v1/files/search.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum passages to return (default 20, vendor maximum 50). |
| query * | string | Question or phrase in natural language. |
| bot_id * | string | Bot id (from botpress_list_bots). |
| consolidate | boolean | Merge passages of the same file into one. |
| contextDepth | integer | Neighbor passages to add as context (default 1). |
{
"name": "botpress_search_files",
"title": "Search files",
"description": "Semantic search over the indexed files of a bot. Returns the best matching text passages. Files API: GET /v1/files/search.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"query"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Maximum passages to return (default 20, vendor maximum 50)."
},
"query": {
"type": "string",
"minLength": 1,
"description": "Question or phrase in natural language."
},
"bot_id": {
"type": "string",
"description": "Bot id (from botpress_list_bots)."
},
"consolidate": {
"type": "boolean",
"description": "Merge passages of the same file into one."
},
"contextDepth": {
"type": "integer",
"maximum": 10,
"minimum": 0,
"description": "Neighbor passages to add as context (default 1)."
}
}
},
"annotations": {
"title": "Search files",
"readOnlyHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| path | string | JSON Pointer from get_bot_content, e.g. /workflows/0/nodes/1/instructions. Use observed paths; never guess a Studio schema. |
| limit | integer | |
| bot_id * | string | |
| offset | integer |
{
"name": "botpress_get_bot_content",
"title": "Inspect Studio bot content",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id"
],
"properties": {
"path": {
"type": "string",
"maxLength": 2048,
"description": "JSON Pointer from get_bot_content, e.g. /workflows/0/nodes/1/instructions. Use observed paths; never guess a Studio schema."
},
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1
},
"bot_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{1,128}$"
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
}
},
"annotations": {
"title": "Inspect bot content",
"readOnlyHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| edits * | array | |
| bot_id * | string | |
| snapshot_hash * | string |
{
"name": "botpress_preview_bot_content_edit",
"title": "Validate and preview Studio text edits",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"snapshot_hash",
"edits"
],
"properties": {
"edits": {
"type": "array",
"items": {
"type": "object",
"required": [
"path",
"value"
],
"properties": {
"path": {
"type": "string",
"maxLength": 2048,
"description": "JSON Pointer from get_bot_content, e.g. /workflows/0/nodes/1/instructions. Use observed paths; never guess a Studio schema."
},
"value": {
"type": "string",
"maxLength": 8000,
"description": "Replacement text for one existing workflow/instruction string. No new keys, node IDs, transitions, credentials or metadata changes."
}
}
},
"maxItems": 20,
"minItems": 1
},
"bot_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{1,128}$"
},
"snapshot_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
},
"annotations": {
"title": "Preview bot content edit",
"readOnlyHint": true
}
}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 persistent operation storage is required. Inspect status/Studio before retrying; success requires readback of text and a changed deployment timestamp.
| Parameter | Type | Description |
|---|---|---|
| edits * | array | |
| bot_id * | string | |
| confirm * | boolean | |
| operation_id * | string | Unique stable ID for this approved publish. Reuse it to inspect/retry; never change it after an uncertain result. |
| preview_hash * | string | |
| snapshot_hash * | string |
{
"name": "botpress_publish_bot_content_edit",
"title": "Publish approved Studio text edits",
"description": "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 persistent operation storage is required. Inspect status/Studio before retrying; success requires readback of text and a changed deployment timestamp.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"snapshot_hash",
"edits",
"operation_id",
"preview_hash",
"confirm"
],
"properties": {
"edits": {
"type": "array",
"items": {
"type": "object",
"required": [
"path",
"value"
],
"properties": {
"path": {
"type": "string",
"maxLength": 2048,
"description": "JSON Pointer from get_bot_content, e.g. /workflows/0/nodes/1/instructions. Use observed paths; never guess a Studio schema."
},
"value": {
"type": "string",
"maxLength": 8000,
"description": "Replacement text for one existing workflow/instruction string. No new keys, node IDs, transitions, credentials or metadata changes."
}
}
},
"maxItems": 20,
"minItems": 1
},
"bot_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{1,128}$"
},
"confirm": {
"type": "boolean",
"const": true
},
"operation_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,180}$",
"description": "Unique stable ID for this approved publish. Reuse it to inspect/retry; never change it after an uncertain result."
},
"preview_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"snapshot_hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
},
"annotations": {
"title": "Publish bot content edit",
"readOnlyHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}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.
| Parameter | Type | Description |
|---|---|---|
| bot_id * | string | |
| operation_id * | string | Unique stable ID for this approved publish. Reuse it to inspect/retry; never change it after an uncertain result. |
{
"name": "botpress_get_content_operation",
"title": "Inspect content publish operation",
"description": "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.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bot_id",
"operation_id"
],
"properties": {
"bot_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.:-]{1,128}$"
},
"operation_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,180}$",
"description": "Unique stable ID for this approved publish. Reuse it to inspect/retry; never change it after an uncertain result."
}
}
},
"annotations": {
"title": "Inspect content publish operation",
"readOnlyHint": true
}
}Tools for Botpress, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "List my Botpress bots and show which ones have runtime issues."; "How many conversations and LLM tokens did my support bot use last week?"; "Show the last 20 conversations of my bot with their messages.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Botpress data. Free plan: 50 tool calls per month. Run botpress_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run botpress_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run botpress_upgrade without a plan: it returns both plans, each with a payment link for the user to open. botpress_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Shared addresses on big platforms (Cloudflare, Vercel and the like) put unrelated servers together; those are marked shared_infrastructure. A match is a pivot, not a link between operators.