Build, edit, and deploy Telegram bots on FlowCastle's hosted visual flow platform.
Connect Remote server
claude mcp add --transport http flowcastle https://api.flowcastle.ai/api/mcp --header "Authorization: Bearer <YOUR_API_KEY>"
{
"mcpServers": {
"flowcastle": {
"url": "https://api.flowcastle.ai/api/mcp",
"headers": {
"Authorization": "Bearer <YOUR_API_KEY>"
}
}
}
}
{
"servers": {
"flowcastle": {
"type": "http",
"url": "https://api.flowcastle.ai/api/mcp",
"headers": {
"Authorization": "Bearer <YOUR_API_KEY>"
}
}
}
}
Settings > Connectors > Add custom connector
URL: https://api.flowcastle.ai/api/mcp
Replace the values in angle brackets with your own. Keys stay on your machine; we never see them.
Tools 65 found in our last check
list_applicationsList the applications this API key can access, with the caller role and the permissions it grants. Start here when using a personal API key (usr_...): every other tool needs an explicit applicationId, which this tool supplies. Read-only, takes no arguments. Returns an array of {…
create_applicationCreate a new application (workspace) owned by the caller. Requires a personal API key (usr_...) — application-scoped keys cannot create applications. Seeds default flows unless skipDefaultFlows is true. Creates persistent state and is NOT idempotent: calling it twice creates two…
update_applicationUpdate application-level settings (name, active state, default language, language for everyone else, incoming-message behavior). Requires the manage_settings permission in that application. Only the fields you pass are changed; omitted fields keep their current value, so the cal…
import_website_knowledgeCrawl a website into a knowledge base so an AI_TOOL_ROUTER can answer from it. Creates a new base (named after the host) unless knowledgeBaseId is given. Honours robots.txt, skips junk and duplicate pages, keeps blog posts by default, and caps at maxPages. Returns at once with a…
get_knowledge_base_documentReturn the FULL text of one knowledge-base document, with contentSha256 — the hash edit_knowledge_base_text_document quotes as expectedSha256. Read-only. get_workspace_summary and get_application_context show each document only as a preview (truncated: true when cut), so read th…
get_website_importStatus of a website import started by import_website_knowledge or an import_website_into_knowledge_base action: stage, progress, counters, warnings and the pages that were not imported. Read-only. Poll until status is DONE, DONE_WITH_ERRORS or FAILED.
list_watched_groupsList the group/channel chats a telegram_mtproto userbot monitors. Read-only. The watched list is the single source of truth for which chats the userbot processes: messages from unlisted group/channel chats are dropped (fail closed) and their contacts never materialize; DMs alway…
list_telegram_operationsDiscover supported Telegram MTProto account operations, input schemas, permissions and limits. Requires manage_broadcasts. All current operations read public data; this catalog does not connect to Telegram. botId may be omitted when the application has exactly one userbot.
execute_telegram_operationSubmit one supported read operation on the connected telegram_mtproto account. Call list_telegram_operations for the input schema. Returns a requestId; poll get_telegram_operation until completed, error or timed_out. Requires manage_broadcasts. Nothing is sent, joined, marked as…
get_telegram_operationRead a Telegram operation status and result using its requestId and the same applicationId/botId used for submission. Requires manage_broadcasts for the owning application. Poll every two seconds. Results expire one hour after their last update. timed_out means no result arrived…
set_watched_groupsReplace a telegram_mtproto userbot's watched-groups list — the chats it monitors. Requires the manage_settings permission. SET semantics: send the COMPLETE desired list every time (call list_watched_groups first and include existing entries you want to keep — omitting one remove…
sync_dialog_contactsImport a telegram_mtproto userbot's existing chats as contacts — DM partners, groups, and channels — so everything the account already talks to becomes a contact send_message can target without waiting for each chat to message first. Importing does not allow sending: send_messag…
get_workspace_summaryReturn a compact application, flow, sequence, operation, and bot summary — the cheapest way to orient in a workspace. Read-only, no side effects. Deliberately omits variables and full flow graphs: use get_variable_context for variables, get_flow_context for a flow's topology, an…
get_variable_contextSearch variable definitions by scope and keyword, or read one variable by id. Read-only. Returns { variables, total, returned, truncated } — compare returned against total to detect a cut-off result set and re-call with a higher limit. Values are withheld unless includeValues is…
get_application_contextReturn the full application-level automation context in one read-only call: every flow (with folders), connected bots, variables, sequences, and operations. This is the broad orientation call — prefer get_workspace_summary when you only need names and counts, since this response…
get_module_catalogReturn a compact index of both installed and available marketplace modules, with each module's key, versions, description, actions, and triggers. Read-only. Start here when you need a capability the core action kinds do not cover; then call get_module_details for the exact input…
get_module_detailsReturn everything needed to use one module: action input fields and their types, trigger configuration, manual setup fields (credentials an operator must fill in the dashboard), and references to already-installed actions. Read-only. Call get_module_catalog first to obtain modul…
install_moduleInstall an exact marketplace module version into an application and create any missing installed-template actions. Requires the manage_automation permission. Call get_module_catalog first to select the module and version, then get_module_details after installation to inspect set…
search_flowsFind every flow and block whose contents contain a keyword. Read-only. Searches message text and its translations, button labels and URLs, action names and configs, action input/output field paths and values, condition operands, trigger commands and payloads, custom-code files,…
get_flow_contextReturn one flow's graph topology: its blocks in reading order from the start block, a short summary per block, and where each block and each menu button leads (links[].to, menu.buttons[].to). Read-only. Deliberately omits block data, action configs and the ids of buttons, action…
get_block_detailsReturn the complete contents of one block: block data, action configs, HTTP request bodies, custom-code files, triggers, menu payloads, and media paths. Read-only. This is the heaviest read in the API — call get_flow_context first to find the block you need rather than walking a…
get_action_schemaRead-only, needs no API key. The action-authoring contract apply_actions batches are validated against. With NO arguments, returns an INDEX of block types, actions, action kinds and topics with descriptions and sizes. Then request only what this bot uses. Detail responses includ…
get_design_guidelinesReturn the flow-design rules that validation does NOT enforce: when to split a branch into its own flow, how navigation and menus must be wired, and worked examples. Read-only, needs no API key. Called with NO arguments it returns a compact INDEX: the short rules every batch nee…
get_funnel_analyticsReturn the measured conversion funnels of the workspace's ENTRY flows over the last 14 days, busiest first: how many new contacts entered, which blocks they reached, the share who stop at each block, which buttons lead nowhere (pressed then silence), and how many recorded a goal…
get_flow_analyticsMeasure how NAMED flows are actually used over the last 14 days: how many contacts entered each one, where inside it they stop (per block, with the stop RATE), how many were answered by a human agent afterwards, and how many hit an error. Unlike get_funnel_analytics this works f…
get_survey_resultsRead what customers ANSWERED in this workspace's surveys. A survey is any flow marked isSurvey: its choice questions record which option each contact tapped, and its free-text questions store the reply the contact typed. Called with NO flowId it lists every survey flow with how…
search_flow_examplesSearch the library of reusable flow examples covering common business cases (lead capture, onboarding, payments, reminders). Read-only, needs no API key. Returns summaries to choose by — id, title, summary, useWhen, tags, requiredModules, hasSchemaExample — with no flow body; pa…
get_flow_exampleReturn one reusable flow example by id, optionally with a complete action batch you can adapt and pass to apply_actions. Read-only, needs no API key. Call search_flow_examples first to find the id.
validate_actionsDry-run validation of a proposed batch of flow-builder actions. Mutates nothing and is safe to repeat. OPTIONAL: apply_actions runs this exact validation itself and applies nothing when invalid, so calling validate_actions first is redundant — use it only to check a draft you do…
apply_actionsValidate and apply a batch of flow-builder actions — the single write path for editing flows, blocks, variables, broadcasts, sequences, and folders. Call this directly; a separate validate_actions call beforehand is unnecessary. Broadcasts have no dedicated tool and are managed…
deploy_applicationPublish the workspace to its bots — the API equivalent of the dashboard's Deploy button. This is the step that makes edits live. apply_actions writes to the DRAFT graph. Until this runs the connected bots keep serving the previously published version, so a change that looks appl…
run_flow_autotestRuns deterministic behavioural tests against flows that are ALREADY applied (compiles them to an AST and simulates a user). Call after apply_actions to verify a build; read `summary` and the failed checks, patch with apply_actions, re-run. Mutates nothing. The smoke layer runs o…
send_messageSend a message to ONE contact right now, outside any flow. For reaching many contacts use a broadcast instead. Target the contact with contactId (globally unique — preferred), or with platformId (the platform-side id, e.g. the Telegram user id). platformId is NOT globally unique…
send_flow_to_contactsRun an EXISTING interactive flow for each listed contact right now, outside any trigger — as if each of them had just triggered it. Use it when the WHOLE message is the flow — its first block's text, media and buttons are what the recipient sees. To send your own custom text wit…
read_messagesRead the message transcript: what users sent the bot and what the bot sent back, newest first. Source is the runtime's own message ledger, written by the bot as it handled each turn — inbound messages are recorded before any routing decision, so messages that matched no trigger…
list_contactsList and search contacts in the application, paginated, newest first. Read-only. Filters combine as AND; search matches name, username, email, phone, and platformId; `tags` / `tagIds` keep only contacts carrying at least one of those tags (UTM attribution tags are named "utm: <s…
list_bot_chatsList the groups and channels the application's bots were added to, newest first: title, kind, the numeric chatId a flow uses to address the chat, when the bot was added, and the bot's status and rights there (is it an administrator, can it invite or remove members). Read-only. A…
list_contact_tagsList the contact tags in use in the application (or one bot) with how many contacts carry each, most-used first. Read-only. This is the attribution view: UTM tags ("utm: <slug>", set by ?start=utm--<slug> deep links, one per ad or campaign) show how many contacts each source bro…
get_contactReturn one contact's full profile plus every contact-variable value stored for them. Read-only. Values may hold personal data; variables of type SECRET are always redacted. Call list_contacts first to find the contactId.
get_contact_activityReturn one contact's engagement history: goals they achieved and buttons they clicked, newest first, plus all-time goal totals. Read-only. This is the per-contact companion to get_broadcast_analytics (which is aggregate). Clicks are inline/menu button presses inside the bot — ty…
list_event_contactsThe reverse lookup: which contacts triggered one analytics event — achieved a goal (kind GOAL + goalKey), clicked a button (BUTTON_CLICK + blockId, optionally buttonId/buttonIndex), were sent a block (BLOCK_SENT + blockId), or received a broadcast (BROADCAST_DELIVERED + broadcas…
create_contactCreate a contact manually — for imports or externally-sourced audiences; contacts who message a bot are created automatically. Requires the manage_broadcasts permission. platformId must be unique within the bot (duplicate fails with 409); botId may be omitted only when the appli…
update_contactUpdate a contact's profile fields and/or contact-variable values. Requires the manage_broadcasts permission. Only the fields you pass are changed — omitted fields keep their current value — so the call is idempotent. The variables map takes variable NAMES (or full folder paths w…
list_broadcastsList broadcasts in the application with status, schedule, and delivery counts. Read-only. Filters combine as AND. Note that delivery counts report messages attempted, not confirmed deliveries. recipientCount is the number of delivery rows once the broadcast has started sending.…
get_broadcast_detailsReturn full details for a single broadcast: status, schedule, recurrence rule, linked flow, and delivery breakdown by status. recipientCount is the number of delivery rows once the broadcast has started sending. Before that it is a live count of the audience only when the audien…
get_broadcast_analyticsReturn engagement analytics for a broadcast: delivery breakdown by status plus per-message-block sent and clicked counts for its flow, over an optional date window. Read-only. Sent counts reflect messages attempted, not confirmed deliveries.
list_releasesList the application's releases, newest first. A release is a frozen copy of everything the editor held when it was published (flows, steps, menus, actions, variables), stored with the rows' own ids. Each entry has its number, when and how it was made (DASHBOARD, MCP, AI_REPUBLI…
restore_releasePut an earlier release back into the editor: every flow, step, menu, action and variable returns exactly as it was, under the same ids, so running conversations, scheduled steps and buttons users already received keep working. Nothing is lost: the current editor state is saved f…
list_pulse_itemsList Pulse items — the workspace attention queue. Two kinds: `attention` is an observed problem a detector found (failing flows, a failed broadcast, an unsubscribe spike), `recommendation` is a proposed improvement. Read-only. Defaults to open items, ordered by severity then due…
get_pulse_itemReturn one Pulse item in full: the measured evidence, the ids of the conversations and execution-log rows behind it, and the change Apply would build if the item carries one. Read-only. Call list_pulse_items first to get the itemId. Note `resolutionPolicy`: an `automatic` item c…
update_pulse_itemChange one Pulse item's state. Every action changes the queue for the WHOLE workspace — an item belongs to the workspace, not to whoever called the tool, so dismissing a recommendation hides it from every member and records who decided that. `acknowledge` closes an attention ite…
list_follow_up_tasksList follow-up tasks — reminders for a person to get back to a contact. Read-only, ordered by due time so overdue work comes first. A follow-up sends nothing by itself. Scopes: `mine` is the open work assigned to the key's owner and needs a personal key; `unassigned` is unowned…
create_follow_up_taskCreate a follow-up reminder for a person to get back to a contact. For work the team owes (checking a database, fixing a bug, a refund), use create_task instead. Creates persistent state and is NOT idempotent: calling it twice creates two reminders. Nothing is sent when it comes…
update_follow_up_taskClose, reopen, snooze, or reschedule one follow-up task. Completing it records that a person handled the reminder — it does not message the contact. Snoozing moves the due time too, so the task reappears when the snooze ends.
list_tasksList CRM tasks — work the team owes, like checking payment records, fixing a bug or sending a refund. Read-only. Tasks live in CRM → Tasks. A task may stand alone or be linked to contacts. While leads are on for the workspace, linking parks the contact's open lead until the task…
create_taskCreate a CRM task, on its own or linked to contacts. Creates persistent state and is NOT idempotent. Tasks live in CRM → Tasks. A task may stand alone or be linked to contacts. While leads are on for the workspace, linking parks the contact's open lead until the task is done (pa…
update_taskChange one CRM task: its fields, its status, or which contacts it is linked to, in one call. Tasks live in CRM → Tasks. A task may stand alone or be linked to contacts. While leads are on for the workspace, linking parks the contact's open lead until the task is done (parkLeads,…
delete_taskDelete one CRM task. Leads parked on it come back to Waiting on us. The task disappears from CRM → Tasks; to finish a task instead, use update_task with status "done".
query_flow_logsRead the bot execution log (flow_execution_log) — the record of what the runtime actually did, and the only place that separates "the action ran" from "the action produced output". Read-only; requires the view_logs permission. Two modes: without groupBy it returns the newest mat…
get_tribute_setupRead the Tribute one-time payment setup of an application: whether a Tribute account is connected, the notification link and whether the owner confirmed it, the products set up here, the number contact variables a purchase can add to, and nextSteps (what is still missing, in ord…
list_tribute_account_productsList the digital products in the owner's connected Tribute account, read live from Tribute, 100 per page, newest first. Read-only; requires manage_automation. Each product says whether it can be set up (only an approved digital product can) and whether it already is. Fails with…
save_tribute_productSet up a product of the connected Tribute account for sale in this application, or change one already set up (one saved product per Tribute product, so calling it again updates). Requires manage_automation. Returns the saved product; its id is the productBindingId of a Payment b…
update_tribute_connectionConnect a Tribute account to the application or change the connection. Requires manage_settings. Pass at least one field; they are applied in the order apiKey, notificationsConfirmed, paused. Returns the same view as get_tribute_setup. The API key is stored encrypted and no tool…
list_tribute_purchasesList the Tribute payments the application received, newest first, 50 per call. Read-only; requires read_payments. Each row has the payment state, the delivery state and, when delivery needs a person, the reason. An empty list means no payment notification has arrived (or no acco…
retry_tribute_deliveryQueue one Tribute payment for delivery again, for a payment that was paid but not delivered. Requires recover_payments. It queues, it does not deliver in the call: read list_tribute_purchases afterwards. Refused with TRIBUTE_REVIEW_REQUIRED for a payment that has a reviewReason.
Headers
| Name | Description |
|---|---|
AuthorizationRequired, secret | Bearer <application API key> — create one in the FlowCastle dashboard: application, API page, MCP tab (keys start with app_) |
Details
| Endpoint | https://api.flowcastle.ai/api/mcp (Streamable HTTP) |
| First published | 14 Jul 2026 |
| Last updated | 14 Jul 2026 |
| Registry name | ai.flowcastle/flowcastle |
More communication servers See all
Listing data from the official MCP registry. Status and tools from NestDaddy's daily check. Browse all MCP servers.
