Tools

Tools perform actions in your business. Create bookings, send messages, update customers, and more. Each tool lists its required scopes.

create_booking

write:bookings

Create a new booking/appointment. Requires either a customerId or customer details (name + email/phone). Returns the created booking ID.

cancel_booking

write:bookings

Cancel an existing booking. The booking must belong to this business and not already be cancelled or completed.

query_availability

read:services, read:bookings

List available time slots for a service on a specific date.

check_availability

read:bookings

Check whether a specific time slot is available.

create_availability_hold

write:bookings

Create a temporary slot hold to prevent double booking during checkout.

extend_availability_hold

write:bookings

Extend an existing slot hold.

release_availability_hold

write:bookings

Release an active slot hold.

get_availability_hold

read:bookings

Get the status of a slot hold for the current session.

add_customer_note

write:customers

Add a note to a customer record. Great for recording preferences, issues, or follow-up reminders.

update_customer_tags

write:customers

Add or remove tags from a customer. Tags help categorize and segment customers (e.g., 'vip', 'new-client', 'prefers-morning').

send_message

write:messaging

Send a message to a customer. Uses their most recent conversation platform if not specified. Returns the message ID and conversation ID.

search_knowledge

read:knowledge

Search the business knowledge base using semantic (AI-powered) search. Great for finding answers to FAQs, policies, service details, and business information.

How to Use Tools

Send a POST request to /api/mcp with:

{
  "type": "tool",
  "name": "create_booking",  // tool name
  "params": { ... }          // required parameters
}

Note: Some tools modify data in your business. Ensure your API key has the required scopes before using tools. Rate limits apply to write operations.