MCP
Tools reference
Every tool the Whazzup MCP server exposes, with parameters and return values.
The Whazzup MCP server exposes 13 tools. Parameters marked „required" must be passed; everything else is optional.
Read tools
get_workspace_overviewShows the connected workspace: name, plan, seats, support hours and your own role. Call this first to orient yourself.
| include | "compact" | "full" (default "compact") – "full" adds support hours |
Returns: Workspace summary and your role.
list_conversationsLists conversations in the support inbox. Filter by queue and search text; paginate with the returned cursor.
| queue | "open" | "mine" | "unassigned" | "snoozed" | "solved" | "archived" | "unanswered" (default "open") |
| query | Search customer name, email, subject or message text |
| cursor | Cursor from the previous response for the next page |
| limit | 1–50 (default 10) |
Returns: Conversations with customer, status, assignee, last message and a next-cursor.
get_conversationReads one conversation with customer details, status and the most recent messages.
| conversationId | Required. Conversation ID from list_conversations |
| messageLimit | 1–50 (default 30) |
Returns: Conversation with messages, oldest first.
search_knowledge_baseFull-text search across help articles and tutorials in your workspace.
| query | Required. At least 2 characters |
| type | "all" | "article" | "tutorial" (default "all") |
| limit | 1–20 (default 8) |
Returns: Matching articles with excerpt and slug.
get_articleReads the full text of one knowledge base article or tutorial, by ID or by slug.
| lookup | Required. "id" or "slug" |
| id | Required when lookup is "id" |
| slug | Required when lookup is "slug" |
Returns: Full article text, category and publish state.
search_contactsFinds customers and visitors by name, email or company.
| query | Required. At least 2 characters |
| limit | 1–20 (default 10) |
Returns: Matching contacts with email, company and country.
get_statisticsSupport metrics for a period: conversation volume, response and resolution times, ratings and active contacts.
| period | "7d" | "30d" | "90d" | "custom" (default "7d") |
| from | Required when period is "custom" (YYYY-MM-DD) |
| to | Required when period is "custom" (YYYY-MM-DD) |
Returns: Metrics with per-day series for the selected period.
Write tools
reply_to_conversationSends an agent reply to the customer in a conversation. The reply appears in the inbox and the website widget with your display name.
| conversationId | Required |
| body | Required. Plain text, line breaks are kept |
Returns: Confirmation with the new message ID.
Note: Duplicate protection: resending the same call does not create a second message (idempotency key).
update_conversationChanges status, priority, assignee and tags of a conversation.
| conversationId | Required |
| status | "open" | "snoozed" | "solved" | "archived" |
| priority | "low" | "normal" | "high" | "urgent" |
| assignee | "me" | "none" | a team member ID |
| tags | Up to 20 tags; replaces all existing tags |
| snoozeUntil | ISO time, required with status "snoozed" |
Returns: The updated conversation state.
create_help_articleCreates a help article or tutorial in the knowledge base, as draft or published, with an optional cover image.
| title | Required. 3–200 characters |
| body | Required. Plain text; blank lines separate paragraphs |
| excerpt | Up to 300 characters |
| category | Existing or new category name |
| type | "article" | "tutorial" (default "article") |
| imageUrl / imageData | Cover image: public https URL or base64 data |
| publish | true publishes immediately (default false) |
Returns: The new article with ID and slug.
Note: Cover images are copied into your workspace. Use upload_image first if you already have the file elsewhere.
create_news_postCreates a news post for the website widget and changelog, as draft or published, with an optional cover image.
| title | Required. 3–200 characters |
| body | Required. Plain text; blank lines separate paragraphs |
| linkUrl / linkLabel | Optional link shown below the post |
| imageUrl / imageData | Cover image: public https URL or base64 data |
| publish | true publishes immediately (default false) |
Returns: Confirmation with the post title.
upload_imageProvides a cover image for a help article or news post and returns a public URL you can pass to the create tools.
| source | Required. "url" or "data" |
| purpose | Required. "article" or "news" |
| url | Required when source is "url" |
| data | Required when source is "data" (base64) |
Returns: Public URL of the stored image.
Note: Up to 5 MB; JPG, PNG, WebP, GIF or SVG.
All writes run with your permissions and are recorded in the workspace activity log (Settings → Activity log).
Diagnostics
check_connectionVerifies the connection end to end: token, plan, workspace access and read rights. Run this when something feels off.
| depth | "basic" | "full" (default "basic") – "full" also runs a sample read |
Returns: Connection status, workspace ID, your identity and per-check results.
Limits
- 120 read and 30 write calls per minute per person;
429on excess – retry after a minute. - Everything is limited to your workspace (row-level security); other workspaces are never visible.
- Answers appear as agent messages with your display name.
- Requires the Unlimited plan.