Tool catalogue

Every tool below is exposed by POST /v1/mcp and delegates to the same service as its REST counterpart, so the behaviour, validation, and tenancy rules documented across these pages apply unchanged. The Scope column is the scope your token needs. Without it the tool still appears in tools/list, and the call fails with INSUFFICIENT_SCOPE — see how scopes are enforced. Tools marked 🔴 delete data permanently.

Contacts

Read and write the people on the other side of your channels. See the Contacts endpoints for the full field reference.

Tool	Scope	What it does
`keebai_contacts_list`	`contacts:read`	List contacts, most recently active first. The way to find a contact id before opening a CRM ticket. Never returns merged contacts or the `playground` channel.
`keebai_contact_get`	`contacts:read`	Get one contact by id, with custom fields and last-activity timestamps.
`keebai_contact_create`	`contacts:write`	Create a contact. `user_id` is the identifier inside the channel — on WhatsApp, the phone without the leading `+`.
`keebai_contact_update`	`contacts:write`	Partial update. An empty string does not clear a field, and `custom_fields` is merged rather than replaced.
🔴 `keebai_contact_delete`	`contacts:delete`	Delete a contact and its change history. Conversations survive.

CRM

The full pipeline: customers, tickets, tasks, notes. See the CRM overview for how the entities relate.

CRM reads are company-wide. Every *_list and *_get tool returns records from every project in your company, not just the one the token was minted for.

Customers

Tool	Scope	What it does
`keebai_crm_customers_list`	`crm:customers:read`	List customers with free-text search and pagination.
`keebai_crm_customer_get`	`crm:customers:read`	Get one customer by id.
`keebai_crm_customer_create`	`crm:customers:write`	Create a customer. No implicit deduplication — calling twice creates two records.
`keebai_crm_customer_update`	`crm:customers:write`	Partial update. `tags` replaces the whole tag list.
🔴 `keebai_crm_customer_delete`	`crm:customers:delete`	Delete a customer.

Tickets

Tool	Scope	What it does
`keebai_crm_tickets_list`	`crm:tickets:read`	List tickets filtered by pipeline, stage, tag, contact, assignee, category, channel, or date.
`keebai_crm_ticket_get`	`crm:tickets:read`	Get one ticket by id.
`keebai_crm_ticket_create`	`crm:tickets:write`	Create a ticket for an existing contact. `chat_user` is required — find it with `keebai_contacts_list`.
`keebai_crm_ticket_update`	`crm:tickets:write`	Update closing state, resolution, priority, amount, tags, and conversation summary.
`keebai_crm_ticket_move_stage`	`crm:tickets:write`	Move a ticket between pipeline stages. Reports whether the destination needs a human and what comes next.
🔴 `keebai_crm_ticket_delete`	`crm:tickets:delete`	Delete a ticket.

Tasks

Tool	Scope	What it does
`keebai_crm_tasks_list`	`crm:tasks:read`	List tasks, optionally filtered by status.
`keebai_crm_task_get`	`crm:tasks:read`	Get one task by id.
`keebai_crm_task_create`	`crm:tasks:write`	Create a task. The creator is the token’s owner.
`keebai_crm_task_update`	`crm:tasks:write`	Update title, assignee, status, priority, due date, or description.
🔴 `keebai_crm_task_delete`	`crm:tasks:delete`	Delete a task.

Notes

Tool	Scope	What it does
`keebai_crm_notes_list`	`crm:notes:read`	List notes, optionally filtered by contact, ticket, or type.
`keebai_crm_note_get`	`crm:notes:read`	Get one note by id.
`keebai_crm_note_create`	`crm:notes:write`	Create a note. It must attach to a contact or a ticket; neither one fails.
`keebai_crm_note_update`	`crm:notes:write`	Update the body or the type. What it is attached to cannot change.
🔴 `keebai_crm_note_delete`	`crm:notes:delete`	Delete a note.

Knowledge

Retrieval and authoring against the tenant knowledge base. See the Knowledge overview.

Tool	Scope	What it does
`keebai_knowledge_search`	`knowledge:query`	Full-text, vector, or hybrid search. Returns `node_id`, title, snippet, and score.
`keebai_knowledge_tree`	`knowledge:read`	The full folder and document tree. Use it to discover `node_id`s.
`keebai_knowledge_folder_create`	`knowledge:write`	Create a folder.
`keebai_knowledge_document_create`	`knowledge:write`	Create a document from Markdown. Triggers a reindex.
🔴 `keebai_knowledge_node_delete`	`knowledge:delete`	Delete a node. Deleting a folder takes its contents with it.
`keebai_knowledge_assign`	`knowledge:assign`	Assign nodes to every worker of an agent.

Messaging

Everything under /v1/messages. Every send tool takes an optional channel (whatsapp, whatsapp_qr, instagram, messenger; defaults to whatsapp) plus channel_id or phone_number_id to pick the concrete channel. Free-form sends only work inside the 24-hour window; outside it, only keebai_send_template gets through.

Tool	Scope	What it does
`keebai_send_text`	`messages:send`	Free-form text.
`keebai_send_template`	`messages:send`	A Meta-approved template. The only way out of the 24-hour window. Pass `flow_token` to bind one of its FLOW buttons.
`keebai_send_image`	`messages:send`	Image by link or `media_id`.
`keebai_send_video`	`messages:send`	Video by link or `media_id`.
`keebai_send_audio`	`messages:send`	Audio file, or a voice note with `voice: true`.
`keebai_send_document`	`messages:send`	PDF, DOCX, and the like.
`keebai_send_sticker`	`messages:send`	WebP sticker.
`keebai_send_location`	`messages:send`	A map pin.
`keebai_send_contacts`	`messages:send`	Share contact cards in a chat. Does not create contacts — that is `keebai_contact_create`.
`keebai_send_reaction`	`messages:send`	React with an emoji; an empty emoji clears it.
`keebai_mark_read`	`messages:send`	Mark an inbound message read, optionally with the typing indicator.
`keebai_send_interactive_buttons`	`messages:send`	Up to 3 quick reply buttons.
`keebai_send_interactive_list`	`messages:send`	A tappable menu, up to 10 sections.
`keebai_send_interactive_cta_url`	`messages:send`	One button that opens a URL.
`keebai_send_interactive_catalog`	`messages:send`	Opens your Meta product catalog.
`keebai_send_interactive_carousel`	`messages:send`	Up to 10 media cards, each with its own URL button.
`keebai_send_flow`	`messages:send`	Send a published WhatsApp Flow as an interactive message.
`keebai_send_raw`	`messages:send`	Escape hatch: an unvalidated Meta Graph API body.
`keebai_send_bulk`	`messages:bulk`	Broadcast a template to up to 5000 recipients. Costs money at Meta.
`keebai_bulk_status`	`messages:bulk`	Progress of a broadcast: sent, failed, pending.

WhatsApp Flows

In-chat forms. See the Flows guide for the full lifecycle.

Tool	Scope	What it does
`keebai_flow_create`	`flows:write`	Register a Flow at Meta and upload its Flow JSON. Starts as a draft.
`keebai_flow_list`	`flows:read`	List the project’s Flows with their status and `meta_flow_id`.
`keebai_flow_get`	`flows:read`	One Flow, including its stored Flow JSON.
`keebai_flow_update`	`flows:write`	Update a draft Flow. Sending `flow_data` re-uploads it at Meta.
`keebai_flow_publish`	`flows:write`	Publish. Meta validates here, and a published Flow can no longer be edited.
🔴 `keebai_flow_delete`	`flows:write`	Delete. Meta only allows this on drafts.

Media

Tool	Scope	What it does
`keebai_media_get`	`messages:send`	Metadata of a WhatsApp media object: mime type, size, sha256, temporary download URL.
🔴 `keebai_media_delete`	`messages:send`	Delete an uploaded media. Messages already sent with it are unaffected.

Uploading and downloading the binary itself is REST-only — POST /v1/media/upload is multipart and GET /v1/media/{id}/download returns raw bytes, and neither fits a JSON tool call.

Ecommerce

Read-only access to the catalog, carts, and sales. See the ecommerce overview for how the records relate — a cart is not a draft sale.

Tool	Scope	What it does
`keebai_ecommerce_products_list`	`ecommerce:products:read`	List the catalog with full-text search. Covers products created in Keebai and those synced from an integration.
`keebai_ecommerce_product_get`	`ecommerce:products:read`	Get one product with its variants, images, and stock.
`keebai_ecommerce_carts_list`	`ecommerce:carts:read`	List carts, including abandoned ones. Filter by recovery status to find the ones worth following up on.
`keebai_ecommerce_cart_get`	`ecommerce:carts:read`	Get one cart with its line items and the customer’s contact details.
`keebai_ecommerce_sales_list`	`ecommerce:sales:read`	List sales by status, payment status, contact, or date range.
`keebai_ecommerce_sale_get`	`ecommerce:sales:read`	Get one sale with its items, amount breakdown, and payment state.

There are no write tools here. Creating a sale or pushing a product goes through the platform integration, not the API.

Loyalty

Points, stamps, and wallet cards. See the loyalty overview for the data model — in particular that there is no reward entity and that balances are a projection, not a sum of the ledger.

Tool	Scope	What it does
`keebai_loyalty_programs_list`	`loyalty:read`	List programs, newest first. Only the rules variant matching the program’s type is populated. Start here for the program id.
`keebai_loyalty_program_get`	`loyalty:read`	Get one program: points per currency unit and expiry, stamps target and reward, or tier thresholds.
`keebai_loyalty_templates_list`	`loyalty:read`	List a program’s wallet card designs. Read-only — the card is designed in the portal.
`keebai_loyalty_template_get`	`loyalty:read`	Get one template with its branding, fields, and barcode.
`keebai_loyalty_memberships_list`	`loyalty:read`	Find a membership by customer id, phone, name, program, or status. Phone matches on a digit subsequence.
`keebai_loyalty_membership_get`	`loyalty:read`	Get one membership with its balance, stamps, and tier.
`keebai_loyalty_membership_enroll`	`loyalty:write`	Enroll a customer. The details are copied as given and never re-resolved; a repeat enrollment conflicts rather than duplicating.
`keebai_loyalty_ledger_list`	`loyalty:read`	Movement history of a membership, newest first, each entry with the balance it produced.
⚠️ `keebai_loyalty_ledger_record`	`loyalty:write`	Move a balance — earn, redeem, or adjust. Updates the card in the customer’s wallet. Not idempotent.
`keebai_loyalty_pass_issue_google`	`loyalty:write`	Issue the Google Wallet pass and return the save link. Reissuing reuses the existing pass.
`keebai_loyalty_pass_issue_apple_link`	`loyalty:write`	Issue the Apple Wallet pass and return a public download link.
⚠️ `keebai_loyalty_pass_notify`	`loyalty:write`	Push a message to the customer’s phone. A real notification to a real person.
`keebai_loyalty_pass_notifications_list`	`loyalty:read`	What was already sent to this membership, and how many devices it reached.

Tools marked ⚠️ have effects outside Keebai. keebai_loyalty_ledger_record moves a balance a customer can spend and is not idempotent — a retried call double-counts. keebai_loyalty_pass_notify sends a push notification to a real phone.Neither is destructive, so neither carries the 🔴 marker, but hand loyalty:write to an agent with the same care you would give messages:send.

Scheduling

Branches, services, professionals, availability, and appointments. See the scheduling overview for the booking model — in particular that an appointment lands in pending, and that reading a slot does not hold it.

Tool	Scope	What it does
`keebai_scheduling_branches_list`	`scheduling:branches:read`	List the active branches, each with its timezone. Start here for the branch id.
`keebai_scheduling_branch_get`	`scheduling:branches:read`	One branch with its address, contact details, and timezone.
`keebai_scheduling_services_list`	`scheduling:services:read`	List services with duration and price, filtered by branch, status, or name. Every availability query needs a service id from here.
`keebai_scheduling_service_get`	`scheduling:services:read`	One service with its duration, slot interval, price, and branches.
`keebai_scheduling_professionals_list`	`scheduling:professionals:read`	List professionals, filtered by branch, service, status, or name.
`keebai_scheduling_professional_get`	`scheduling:professionals:read`	One professional with specialties and branches.
`keebai_scheduling_availability_by_date`	`scheduling:availability:read`	Free slots for a service on one day, grouped by professional.
`keebai_scheduling_availability_range`	`scheduling:availability:read`	Free slots day by day between `from` and `to`, at most 14 days.
`keebai_scheduling_availability_next`	`scheduling:availability:read`	The soonest free slots for a service, up to `limit` per professional.
`keebai_scheduling_appointment_get`	`scheduling:appointments:read`	One appointment by id.
⚠️ `keebai_scheduling_appointment_create`	`scheduling:appointments:create`	Book a slot with the customer embedded. Lands in `pending`, and already occupies the slot.
⚠️ `keebai_scheduling_appointment_confirm`	`scheduling:appointments:confirm`	Move a `pending` appointment to `confirmed`. Any other state fails.
⚠️ `keebai_scheduling_appointment_cancel`	`scheduling:appointments:cancel`	Cancel and release the slot, with an optional reason.

Arguments keep the REST names: the availability and list tools take serviceId, branchId, and professionalId like the query strings they mirror, while keebai_scheduling_appointment_create takes branch_id, service_id, and start_time like the request body. Dates are YYYY-MM-DD and times HH:mm, both in the branch’s timezone. The appointment id is a UUID, not an ObjectId.

Tools marked ⚠️ reach the customer. Creating, confirming, or cancelling fires the scheduling webhooks, the CRM event on the contact’s timeline, and the reminder and confirmation notifications the account has configured.A slot read from availability is a snapshot, not a hold. When keebai_scheduling_appointment_create fails because the slot was taken, the agent should query availability again and offer the new options rather than retry the same time. An appointment left in pending holds its slot until someone cancels it; nothing expires it.

Agents

Read and write the configuration of the agents themselves: their goal, the sections of their prompt, the funnel, and the webhook tools they can call. Twenty-five tools, all on agents:read or agents:write.

Tool	Scope	What it does
`keebai_agent_prompt_types`	`agents:read`	The catalogue: which sections, goals and channels exist. Read this before writing, instead of a hardcoded list.
`keebai_agents_list`	`agents:read`	List the active agents of the project. Start here for the id everything else needs.
`keebai_agent_get`	`agents:read`	One agent whole: goal, sections with their text, channels, tools, knowledge.
`keebai_agent_create`	`agents:write`	Create one. `stages` creates a CRM pipeline named after the agent and limits it to those stages.
`keebai_agent_update`	`agents:write`	Partial update of the config. Sending `prompts` replaces them all.
🔴 `keebai_agent_delete`	`agents:write`	Delete permanently, with its sections and their history.
`keebai_agent_query`	`agents:read`	Write to the agent as a customer and read its answer. Always in test mode: write tools are simulated.
`keebai_agent_prompts_list`	`agents:read`	The sections of one agent, with their text.
`keebai_agent_prompt_set`	`agents:write`	Write ONE section, leaving the rest alone. Every save leaves a version.
`keebai_agent_prompt_delete`	`agents:write`	Remove a section. Its history stays.
`keebai_agent_prompt_versions_list`	`agents:read`	The history of a section, newest first.
`keebai_agent_prompt_version_get`	`agents:read`	One version, to diff it before restoring.
`keebai_agent_prompt_version_restore`	`agents:write`	Restore a version by writing a new one that copies it. Nothing is lost.
`keebai_agent_tools_list`	`agents:read`	The company’s webhook tools. Secret values come back masked.
`keebai_agent_tool_get`	`agents:read`	One tool with its URL and parameters.
⚠️ `keebai_agent_tool_create`	`agents:write`	Create a webhook the agent can call. The URL must be a public https host.
⚠️ `keebai_agent_tool_update`	`agents:write`	Partial update. Omitting headers keeps the stored ones; never echo back a `***`.
🔴 `keebai_agent_tool_delete`	`agents:write`	Delete permanently. Fails while an agent still holds it.
`keebai_agent_tool_attach`	`agents:write`	Give one tool to an agent without resending the list. Idempotent.
`keebai_agent_tool_detach`	`agents:write`	Take one tool off an agent. It still exists in the company.
`keebai_agent_knowledge_attach`	`agents:write`	Give one knowledge node to an agent. Idempotent.
`keebai_agent_knowledge_detach`	`agents:write`	Take one knowledge node off an agent.
`keebai_agent_channel_attach`	`agents:write`	Enable one channel. Only half of it: the account must be connected too.
`keebai_agent_channel_detach`	`agents:write`	Disable one channel. It stops answering there.
`keebai_agent_reengagement_set`	`agents:write`	How often it comes back to a cold conversation. `max_attempts: 0` turns it off.

Writing here changes what your bots say to customers. An agent with agents:write can rewrite any prompt section and create webhook tools that make Keebai’s infrastructure call an external host — the URL is validated against loopback, private ranges and internal names, but a public host of the agent’s choosing is allowed. Treat it as a higher-privilege scope than the read side, and read webhook security before handing it out.Tools are company-wide, unlike agents and their sections, which are scoped to the token’s project.keebai_agent_query never touches real data. It runs the turn with the write tools simulated, so an agent can verify its own change without booking anything.

Not exposed as tools

Templates, channels, webhooks, tenants, and setup links have no MCP tools yet. Use the REST API for those. CRM events are not tools either, and that one is on purpose rather than pending. Emitting an event is a system-of-record write from a system that knows something happened — an order closed, a delivery completed. A model deciding to emit one is a model asserting a fact it cannot verify. Call POST /v1/webhook/events from the system that owns the fact.

Keebai’s own agents can emit events, through an internal tool gated by an ai_triggerable flag you set per event type in the portal. That flag defaults to off and does not apply to this MCP server, which is your agent talking to the API, not Keebai’s agent talking to itself.

The binary Apple .pkpass has no tool either, for the same reason as media download: it is a file, not JSON. The Apple link tool covers the same use case.

Get started

Authentication

MCP

SDK

CLI

Agent Skills

Limits

Tool catalogue

Contacts

CRM

Customers

Tickets

Tasks

Notes

Knowledge

Messaging

WhatsApp Flows

Media

Ecommerce

Loyalty

Scheduling

Agents

Not exposed as tools

​Contacts

​CRM

​Customers

​Tickets

​Tasks

​Notes

​Knowledge

​Messaging

​WhatsApp Flows

​Media

​Ecommerce

​Loyalty

​Scheduling

​Agents

​Not exposed as tools

Contacts

CRM

Customers

Tickets

Tasks

Notes

Knowledge

Messaging

WhatsApp Flows

Media

Ecommerce

Loyalty

Scheduling

Agents

Not exposed as tools