Botsify Skill

1---
2name: botsify-api
3description: >-
4  Operate Botsify workspaces through the botsify-api-mcp server: login, create
5  chatbot/agent/voice bots, versions, builder streams, converse messaging,
6  WhatsApp, analytics, and whitelabel. Use when the user mentions Botsify, this
7  MCP, Smithery botsify-api-mcp, agent versions, converse streams, or Botsify
8  Postman APIs.
9---
10 
11# Botsify API (MCP)
12 
13Use the **Botsify APIs** MCP (`botsify-api-mcp`), not raw HTTP, unless the user asked for curl.
14 
15Do not invent JWT/API keys. Auth is `POST /v1/login` (tool `login-account`). The server stores the Bearer token. After login, `last_selected_bot` is the default `apikey` / `bot_key`. Switch with `select-bot`.
16 
17Default base URL: `https://botsify.com/api`. Config: `email`, `password`, optional `baseUrl`. Env: `BOTSIFY_EMAIL`, `BOTSIFY_PASSWORD`, `BOTSIFY_API_BASE_URL`.
18 
19OpenAPI for these tools: `openapi.json` in the MCP package. Public Postman: https://documenter.getpostman.com/view/9852076/2sBY4WoH2X
20 
21## Session order
22 
231. `login-account` (omit email/password if Smithery/env already set them).
242. `list-workspace-agents` (or `list-owned-bots`).
253. `select-bot` with `apikey` from the list (or skip if `last_selected_bot` is already correct).
264. Call domain tools. Confirm `bot_id` vs bot API key — they are different.
27 
28| Identifier | What it is | Typical tools |
29| --- | --- | --- |
30| `apikey` / `bot_key` | Bot API key string | `select-bot`, `activate-agent-version.bot_id`, converse |
31| numeric `bot_id` | Database id | `rename-agent`, `delete-agent`, `clone-agent`, `save-agent-version`, inbox |
32 
33`agent_type` on create: `chatbot` | `agent` | `voice`.
34 
35## Workflows
36 
37**Create then configure**
38 
391. `create-agent` (`bot_name`, `agent_type`, optional marketplace `template`) — new `bot_api_key` is stored.
402. `get-bot-details`
413. `save-agent-version` with the **full** `agent` text and `chat_flow` JSON (not a fragment).
424. `activate-agent-version` or `deploy-agent-version`
43 
44**Patch one instruction column**
45 
46`patch-instruction-section` with `field`: `agent` | `memory` | `soul` | `identity` | `user_info`.
47 
48**Builder**
49 
50`start-builder-chat` → `stream-builder` (`messages` as `{role, content}` objects, optional `stream_id`) → `store-builder-response` with the stream `response_id` → next turn. Cancel: `stop-builder-stream`. Reset: `clear-builder-conversation`.
51 
52**Talk to an end user**
53 
54- Website/API user: `send-converse-message` or `stream-user-message` (`fbId` max 16 chars). Stop: `stop-user-message-stream`. History: `get-converse-history`.
55- Inbox: `send-inbox-message` (numeric `bot_id` + `fbId`).
56- Outbound channel: `send-user-message` (`to` = fbId or phone; optional `type` `whatsapp` | `sms`).
57- Agentic query: `query-mcp-agent`.
58- Legacy stories: `get-query-response`.
59 
60**WhatsApp**
61 
62`create-whatsapp-template` → `list-whatsapp-templates` → `send-whatsapp-broadcast` → `get-whatsapp-broadcast-report`.
63 
64**Destructive**
65 
66Confirm before `delete-agent`, `delete-agent-versions` (active versions cannot be deleted), `clear-builder-conversation`.
67 
68## Tool map
69 
70Auth: `login-account`, `create-oauth-token` (`client_id`/`client_secret` from login).
71 
72Agents: `create-agent`, `list-workspace-agents`, `get-bot-details`, `select-bot`, `rename-agent`, `delete-agent`, `clone-agent`, `list-owned-bots`.
73 
74Versions: `list-agent-versions`, `save-agent-version`, `patch-instruction-section`, `activate-agent-version`, `delete-agent-versions`, `deploy-agent-version`.
75 
76Builder: `stream-builder`, `store-builder-response`, `stop-builder-stream`, `start-builder-chat`, `clear-builder-conversation`.
77 
78Messaging: `send-user-message`, `stream-user-message`, `stop-user-message-stream`, `list-conversations`, `get-user-chat`, `send-inbox-message`, `send-converse-message`, `get-query-response`, `query-mcp-agent`, `get-converse-history`, `set-user-attribute`, `list-messenger-users`, `list-bot-messenger-users`, `change-user-activation`.
79 
80Analytics: `get-bot-dashboard-stats`.
81 
82WhatsApp: `send-whatsapp-broadcast`, `create-whatsapp-template`, `list-whatsapp-templates`, `get-whatsapp-broadcast-report`.
83 
84Whitelabel: `list-whitelabel-clients`, `create-whitelabel-client`, `create-whitelabel-package`, `list-whitelabel-packages`.
85 
86If a tool is missing, read `src/server.ts` `registerTool` names — do not guess old Postman names (`authorize`, `get_bots`, `use_bot`).
87 
88## Run the MCP
89 
90```bash
91cd botsify-api-mcp
92npm install && npm run build && npm start
93```
94 
95Smithery: `email` + `password` required; `baseUrl` optional. HTTP: `npm run start:http`.
96