BookingKoala MCP Server
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@BookingKoala MCP Servershow me today's unassigned bookings"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
BookingKoala API and MCP server, self-hosted
A BookingKoala API and a BookingKoala MCP server you run on your own computer, in Python, on the session of your own Google Chrome. 17 of the 18 BookingKoala tools we run in production at Cotlet: bookings, drafts and quotes, customers, providers and teams, charges, invoices and the store dashboard.
BookingKoala has no public API and no official MCP server. Its API key only connects Zapier and Make, which react to new events and can write back one thing, a lead. This repo gives you both:
MCP server for Claude Code, Claude Desktop, Cursor, Codex and any MCP client, over stdio or HTTP. Setup
REST API on
http://127.0.0.1:8787/api/v1/bookingkoala, with OpenAPI docs at/docs. SetupPython:
call("list_bookings", status="unassigned"), plus 12 ready scripts inexamples/.
It is for technical people who want to run it themselves, for personal use only (license). If you want it running 24/7 on a server, kept working when BookingKoala changes its app, for a team or a business, use the hosted version at cotlet.dev.
git clone https://github.com/cotletdev/bookingkoala-api-mcp-server.git && cd bookingkoala-api-mcp-server
python3 -m venv .venv && . .venv/bin/activate && pip install -e .
bookingkoala-mcp connect # reads your BookingKoala session from Chrome
bookingkoala-mcp call list_bookings status=upcoming
claude mcp add bookingkoala -- "$PWD/.venv/bin/bookingkoala-mcp" mcpContents
Related MCP server: jobkeepr-mcp
How it works
AI agent (MCP) / script (REST, Python) ──▶ bookingkoala-mcp on your computer ──your session──▶ yourstore.bookingkoala.com
▲
bookingkoala-mcp connect ─────┘ reads it once from your Chrome (DevTools Protocol)You sign in to your BookingKoala store admin in your own Chrome, the way you always do.
bookingkoala-mcp connectattaches to that Chrome through the Chrome DevTools Protocol, reads the bookingkoala.com cookies and your time zone, and saves them to~/.config/bookingkoala-api-mcp/session.json, readable by your user only. It never sees or stores your password.Every tool call is a request to the admin API your store's own web app calls, on
yourstore.bookingkoala.com, sent with curl_cffi, which copies Chrome's TLS fingerprint. The server signs each request the way the app does: a bearer token from your session and a new per-request header. No headless browser runs.
BookingKoala keeps the session for 30 days in the IRON_GATEWAY_CTX cookie of your store's host. When it signs you out, the server reads the session from Chrome again, if Chrome is open with remote debugging on.
Requirements
Python 3.11 or newer.
Google Chrome 144 or newer, signed in to your BookingKoala store admin. Any Chrome or Chromium works with a debugging port.
macOS, Linux or Windows.
A store admin account. The tools can do what your BookingKoala role may do in the admin panel. A staff role with fewer permissions gets a refusal where the panel would show one.
Install
git clone https://github.com/cotletdev/bookingkoala-api-mcp-server.git
cd bookingkoala-api-mcp-server
python3 -m venv .venv
. .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e .
bookingkoala-mcp --versionWith uv: uv venv && uv pip install -e ., then uv run bookingkoala-mcp ....
Setting it up with an AI agent (Claude Code, Codex, Cursor)? Open it in this folder and ask it to set up the repo: AGENTS.md tells it every step, and it asks you only for the steps in Chrome.
To update: git pull && pip install -e .. We copy every change of the hosted BookingKoala tools into this repo.
Connect your Chrome
Option A: your everyday Chrome (recommended)
Open
chrome://inspect/#remote-debuggingin Chrome and switch remote debugging on. Chrome then accepts DevTools connections from programs on this computer, and asks you before each one.Make sure you are signed in to your store admin at
https://yourstore.bookingkoala.com/admin.Run:
bookingkoala-mcp connectChrome asks whether to allow the connection. Click Allow.
Saved 15 BookingKoala cookies to /Users/you/.config/bookingkoala-api-mcp/session.json
Signed in to BookingKoala as Dana Whitfield (dana@sparkleclean.com), sparklecleanYou can switch remote debugging off again afterwards. Leave it on if you want the server to pick up a new session by itself after BookingKoala signs you out.
connect looks for Chrome's DevToolsActivePort file in the default profile folder. For Chrome Beta, Canary or a custom profile folder, pass --profile-dir "<folder>".
Option B: a Chrome with a debugging port
Chrome does not open a debugging port on your default profile, so start a separate one, sign in to BookingKoala there once, and connect to it:
# macOS
"/Applications/Google Chrome.app/Contents/MacOS/Google Chrome" --remote-debugging-port=9222 --user-data-dir="$HOME/.chrome-bookingkoala"
# Linux
google-chrome --remote-debugging-port=9222 --user-data-dir="$HOME/.chrome-bookingkoala"
# Windows
"C:\Program Files\Google\Chrome\Application\chrome.exe" --remote-debugging-port=9222 --user-data-dir="%USERPROFILE%\.chrome-bookingkoala"
bookingkoala-mcp connect --cdp http://127.0.0.1:9222--cdp also takes a ws:// DevTools URL, for example of a Chrome on another machine reached over an SSH tunnel.
Option C: paste the cookie by hand
For a server with no Chrome: in Chrome open DevTools on your store admin, Application > Cookies > https://yourstore.bookingkoala.com, copy the value of IRON_GATEWAY_CTX, then:
bookingkoala-mcp connect --token # asks for your store name, then the value (hidden)
# or, without a session file:
export BOOKINGKOALA_STORE=yourstore BOOKINGKOALA_AUTH_TOKEN=...A pasted cookie is not refreshed on its own. Paste a new one when BookingKoala signs you out, at the latest after 30 days. Tools that say "today" then use this computer's time zone.
Check the session at any time:
bookingkoala-mcp statusMCP server
The MCP server lists every tool with its input schema, a description written for agents, and hints. Read tools are marked read-only. Tools that email customers, notify providers or cancel are marked so your client asks before running them.
Claude Code
claude mcp add bookingkoala -- /path/to/bookingkoala-api-mcp-server/.venv/bin/bookingkoala-mcp mcp
# read only:
claude mcp add bookingkoala -- /path/to/bookingkoala-api-mcp-server/.venv/bin/bookingkoala-mcp mcp --read-onlyClaude Desktop
~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"bookingkoala": {
"command": "/path/to/bookingkoala-api-mcp-server/.venv/bin/bookingkoala-mcp",
"args": ["mcp"]
}
}
}Cursor
~/.cursor/mcp.json, the same block as Claude Desktop. A ready copy is in mcp.json.
Codex
~/.codex/config.toml:
[mcp_servers.bookingkoala]
command = "/path/to/bookingkoala-api-mcp-server/.venv/bin/bookingkoala-mcp"
args = ["mcp"]Over HTTP
bookingkoala-mcp serve also serves MCP over streamable HTTP at http://127.0.0.1:8787/mcp, for clients that take a URL:
bookingkoala-mcp serve
claude mcp add --transport http bookingkoala http://127.0.0.1:8787/mcpThen ask your agent things like:
Go through the unassigned folder for this week. Give each job to the free provider with the fewest bookings that day, and tell me which jobs nobody can take.
Thursday is a storm day. Move every Thursday booking to its next visit and email the customers and providers.
Which invoices are more than 7 days overdue? Send each customer the invoice again.
How much revenue and provider pay did we have from 1 to 15 November?
REST API
bookingkoala-mcp serve # http://127.0.0.1:8787, MCP at /mcp, docs at /docsEach tool has its own route under /api/v1/bookingkoala, the same paths as the hosted API at cotlet.dev, so code written against one works with the other. Path parts and the query string are arguments, and a JSON body adds the rest.
curl 'http://127.0.0.1:8787/api/v1/bookingkoala/bookings?status=unassigned&start_date=2026-11-16&end_date=2026-11-20'
curl 'http://127.0.0.1:8787/api/v1/bookingkoala/bookings/212'
curl -X POST http://127.0.0.1:8787/api/v1/bookingkoala/bookings/212/assign \
-H 'Content-Type: application/json' \
-d '{"provider_id": 3}'Any tool by name, body as its arguments:
curl -X POST http://127.0.0.1:8787/api/v1/bookingkoala/tools/list_customers -d '{"search": "whitfield"}'GET /api/v1/bookingkoala/tools: every tool with its route, input schema and an example answer.GET /docs: interactive OpenAPI docs,GET /openapi.jsonthe schema, for n8n, Postman or a generated client.Answers are JSON. Lists return
next_cursor; pass it back ascursorfor the next page.
The server listens on 127.0.0.1 only. To reach it from another device of yours, set a token, and every request then needs Authorization: Bearer <token>:
BOOKINGKOALA_MCP_TOKEN=$(openssl rand -hex 24) bookingkoala-mcp serve --host 0.0.0.0Python and the example scripts
Straight from Python, no server needed:
from bookingkoala_api_mcp import call
from bookingkoala_api_mcp.scripting import paginate, write_rows
totals = call("dashboard", start_date="2026-11-01", end_date="2026-11-15")
bookings = list(paginate("list_bookings", {"status": "completed", "start_date": "2026-11-01"}, "bookings"))
write_rows(bookings, "completed.csv")
call("assign_provider", booking_id=212, provider_id=3)Or one tool from the shell: bookingkoala-mcp call list_customers search=whitfield, or with a JSON object.
Ready scripts in examples/. Each prints JSON, takes --out file.csv or --out file.json where it makes sense, and --help:
Script | What it does |
Bookings by status and date range: date, arrival time, customer, address, providers, total. | |
Customers to CSV or JSON: name, email, phone, tags, note. | |
Store totals for a date range: revenue, provider pay, bookings, ratings, referrals. | |
Gives each unassigned job to the provider with the fewest jobs that day. Shows the plan unless you pass | |
Assigns one booking, or its whole recurring schedule, to a provider or team. | |
Moves a closed day's recurring visits to their next visit date. Plan first, | |
Cancels one booking or the rest of its schedule, with no fee, after you confirm. | |
Copies a repeat customer's last visit into a draft. | |
Lists saved drafts and quotes, or emails one quote with a link to book it. | |
Adds a customer after checking the email is not in the store yet. | |
Provider pay totals for a pay period, then each provider's payment logs. | |
Unpaid invoices past due. |
python examples/assign_unassigned.py --from 2026-11-16 --to 2026-11-20
python examples/overdue_invoices.py --days 7 --out overdue.csvOn a schedule, cron on your own computer works while it is on: 0 7 * * 1-5 cd ~/bookingkoala-api-mcp-server && .venv/bin/python examples/list_bookings.py --status today.
All 17 tools
Ids come from the list tools: booking_id from list_bookings, customer_id from list_customers, provider_id from list_providers, draft_id from list_drafts, invoice_id from list_invoices. bookingkoala-mcp tools prints this list, bookingkoala-mcp tools --json adds the input schemas.
Bookings
Tool | Access | REST route | What it does |
| read |
| Bookings of the store: upcoming, unassigned, completed, charge pending or declined. |
| read |
| One booking with its price breakdown, provider pay, notes and service. |
| write |
| Start a new booking as a copy of an existing one: same customer, service and price. |
| write |
| Assign a provider or team to a booking, or to its whole recurring schedule. |
| write |
| Postpone a visit of a recurring booking to the date of a later visit in its schedule. |
| write |
| Cancel one booking or its whole recurring schedule, without a cancellation fee. |
Drafts and quotes
Tool | Access | REST route | What it does |
| read |
| Draft bookings and quotes saved in the store, not yet booked. |
| write |
| Email a saved quote to the customer with a link to book it. |
Customers
Tool | Access | REST route | What it does |
| read |
| Customers of the store, with email and phone; search by name, email or phone. |
| read |
| One customer: contact details, addresses, booking counts and bookings not charged yet. |
| write |
| New customer in the store. BookingKoala emails them an invitation to set a password. |
Providers and teams
Tool | Access | REST route | What it does |
| read |
| Providers (cleaners, technicians) and teams of the store, in priority order. |
| read |
| One provider or team: contact, category, team members, reviews and payment logs. |
Charges, invoices and reports
Tool | Access | REST route | What it does |
| read |
| Charged bookings with their payments and refunds, as the Charges page lists them. |
| read |
| Invoices of the store or of one customer, with payment status, total and amount due. |
| write |
| Send an invoice to its customer again by email, text or both. |
| read |
| Store totals for a date range: revenue, provider pay, bookings, ratings, referrals. |
Never built, on purpose: your BookingKoala sign-in, password and profile, your own BookingKoala plan and billing, and anything else that moves money. Every request passes a guard that refuses those BookingKoala paths.
Not in this version
Tool | Why |
| It sends money back to a customer's card. The hosted version has it, with your approval for each call. Here, refund in the panel under Charges. |
Configuration
Variable | Default | What it does |
|
| Folder of |
| Value of the | |
| Your store name, | |
| Proxy for every request to BookingKoala, e.g. | |
|
| |
| Bearer token required by | |
|
| Address of |
Security and your BookingKoala account
Your password never reaches this code. Only cookies are read, and only those of bookingkoala.com.
The session file is yours.
session.jsonis created with mode 0600. Anyone who has it can act as you in your store admin, so keep it out of git and shared folders.Local by default.
servebinds to127.0.0.1and refuses another address withoutBOOKINGKOALA_MCP_TOKEN.bookingkoala.com only. Requests and redirects outside bookingkoala.com are refused.
Read-only mode.
--read-onlyorBOOKINGKOALA_MCP_READ_ONLY=1exposes the 10 read tools only.Actions reach real people. Assigning tells the provider. Quotes and invoices go to customers, a new customer gets an invitation email, and
notifyon a cancel or reschedule emails both sides. MCP clients ask before running them. A script does not, so try it on a test booking first.You answer for what runs in your store. Keep to your normal use of BookingKoala.
Errors
The REST API answers {"error": "<code>", "message": "..."}. The MCP server returns the same code and message as a tool error.
Status | Code | What to do |
401 |
| No session, or BookingKoala signed you out. Sign in to your store admin in Chrome and run |
403 |
| Your BookingKoala role cannot do this. |
403 |
| The server runs read-only, or the request would touch your sign-in or billing. |
403 |
| BookingKoala refused the request or showed a bot check. Open your store admin in Chrome once, then retry. |
409 |
| BookingKoala asks for a CAPTCHA. Solve it in Chrome. |
422 |
| An argument is missing or wrong; the message names it. |
429 |
| BookingKoala is limiting the account. Wait a few minutes. |
502 |
| BookingKoala answered with an error, or changed its app. The message carries BookingKoala's own reason. |
Self-hosted or hosted
This repo | ||
Tools | 17 | 18, with |
Runs | on your computer, while it is on | in the cloud, 24/7 |
BookingKoala session | your Chrome, cookies in a local file | your own Cloud Browser in the EU, profile encrypted with AES-256-GCM |
When BookingKoala changes its app |
| fixed for you, every tool tested daily |
Approvals | your MCP client asks per call | assignments, quotes, invoices and refunds wait for your OK, switchable per tool |
Works with | MCP clients on your machine, local scripts | Claude.ai and ChatGPT connectors, n8n, Make, Zapier, any HTTP client |
Who may use it | you, for personal use | teams, businesses, agencies |
Price | free | free 7-day trial with 2,000 credits, no card; then one-time packs from $29 for 5,000 credits |
On the hosted version a successful call uses 20 to 30 credits (25 for most tools), failed calls are free, and the Cloud Browser uses 50 credits a day while it has an app enabled for agents. Full pricing.
FAQ
Does BookingKoala have an official API? Not a public one. BookingKoala publishes no REST API docs. The API key under Settings > General > Apps & Integrations only connects Zapier and Make: triggers for new or updated bookings, customers, providers, quotes, ratings and invoices, and one action, Create Lead. It cannot look up past bookings, assign a provider, reschedule, cancel or resend an invoice. Details: cotlet.dev/integrations/bookingkoala-api-mcp-server.
Is there a BookingKoala MCP server for Claude, ChatGPT or Cursor?
Yes, this one runs on your machine: bookingkoala-mcp mcp for Claude Code, Claude Desktop, Cursor and Codex. ChatGPT and Claude.ai connectors need a public HTTPS URL, which the hosted BookingKoala MCP server gives you.
Do I need Zapier or a BookingKoala API key? No. The tools use your signed-in admin session, the same one your browser uses.
Can I export BookingKoala bookings or customers to CSV?
Yes: python examples/list_bookings.py --status all --out bookings.csv and python examples/export_customers.py --out customers.csv, across all pages.
Can it assign providers automatically?
examples/assign_unassigned.py gives each unassigned job to the provider with the fewest jobs that day, after it shows you the plan. BookingKoala still refuses a provider who is not available at that time, and the script lists those jobs.
Why does it need my Chrome? To read your BookingKoala session without your password. Chrome is used once per sign-in, not for each call.
What happens when BookingKoala signs me out?
Calls fail with auth_expired. With Chrome remote debugging on, the server reads the new session on the next call (click Allow when Chrome asks). Otherwise run bookingkoala-mcp connect again.
Can it run on a VPS or in Docker?
Technically yes, with BOOKINGKOALA_STORE and BOOKINGKOALA_AUTH_TOKEN. BookingKoala then sees your session from a datacenter IP, and the license allows it only on a server you alone use. For an always-on setup the hosted version keeps your session in your own Cloud Browser on a fixed IP.
Can I use it for my cleaning business? No. The license is for personal use by one person, and running your store is business use. For your company, use Cotlet or write to contact@cotlet.dev.
Is it open source? The source is public, the license is not an open source license: personal use only, no business use, no hosting for others.
A tool broke or I need another one. Open an issue with the tool name and the error message.
License
Cotlet Personal Use License 1.0. In short:
Allowed: one person, on their own computers, with their own BookingKoala accounts, for their own purposes. Changing the code for yourself, and a GitHub fork under the same license.
Not allowed: any use in or for a company or organization, your own business included; letting other people use your instance (shared server, team machine, cloud service); selling or offering it or a service built on it.
Maintained by Cotlet (@cotletdev). BookingKoala is a trademark of its owner. This project is unofficial and not affiliated with, endorsed or sponsored by BookingKoala.
Available Tools
17 toolsassign_providerAssign providerADestructive
Assign a provider or team to a booking, or to its whole recurring schedule.
Puts the provider on the booking, as Assign in the booking's sidebar does, and returns the booking as get_booking shows it. BookingKoala tells the provider about the job. A provider who is not available at that time is refused unless even_if_unavailable is true.
| Name | Required | Description | Default |
|---|---|---|---|
| booking_id | Yes | Booking id from list_bookings. | |
| provider_id | Yes | Provider or team id from list_providers. | |
| whole_schedule | No | Assign every later booking of the recurring schedule too. Default: false. | |
| even_if_unavailable | No | Assign although the provider is not available then. Default: false. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds significant behavioral detail beyond annotations: it notifies the provider, returns the booking as get_booking shows it, and refuses unavailable providers unless overridden. It does not explicitly state whether an existing provider is replaced (though destructiveHint=true implies mutation), but overall transparency is strong.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with the core action and scope, followed by behavioral details. Zero waste; every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the mutation nature (annotations cover safety) and absence of an output schema, the description explains return shape, side effects (provider notification), and refusal logic. It is complete enough for an agent to call correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds meaning for even_if_unavailable (refusal logic) and implies whole_schedule scope ('or to its whole recurring schedule'), going beyond the schema's brief default descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb (assign) and resource (provider or team to a booking), and explicitly extends scope to the whole recurring schedule. It clearly distinguishes the operation from siblings like create_booking or reschedule_booking.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives clear context ('as Assign in the booking's sidebar does') and a key conditional behavior (refusal when unavailable unless even_if_unavailable is true). However, it does not explicitly compare to alternative tools or state when not to use it, though no direct sibling performs assignment.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
cancel_bookingCancel bookingADestructive
Cancel one booking or its whole recurring schedule, without a cancellation fee.
Checks the store's cancellation rules first (a store that requires a reason gets the 'Other' reason with your text), then cancels as Cancel in the booking's sidebar does, with no fee. Nobody is told unless notify is true. Cancelled bookings leave list_bookings.
| Name | Required | Description | Default |
|---|---|---|---|
| notify | No | Email the customer and providers about it. Default: false. | |
| reason | No | Why it is cancelled (kept on the booking). | |
| booking_id | Yes | Booking id from list_bookings. | |
| whole_schedule | No | Cancel the whole recurring schedule from this booking on. Default: false. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and openWorldHint=true, but the description adds substantive behavior: no cancellation fee, store-rules precheck that injects an 'Other' reason with the caller's text, silence unless notify=true, and removal from list_bookings. These are exactly the side effects an agent needs before committing an irreversible action.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four short sentences, front-loaded with scope and the key reassurance (no fee), followed by preconditions, effects, and post-state. No redundant restatement of the name or title.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive, non-idempotent mutation with no output schema and four params, the description covers preconditions, fee implications, notification behavior, and resulting visibility. Nothing material is left for the agent to guess.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3; the description goes further by explaining the semantics of `reason` (auto-filled as 'Other' when the store demands a reason) and the consequence of `notify` (nothing is communicated unless true). That is meaning beyond the schema's plain field descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Specific verb (cancel) plus resource (booking), with exact scope stated as 'one booking or its whole recurring schedule.' An agent can distinguish it from reschedule_booking and get_booking without opening any schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives clear context for use — checks the store's cancellation rules first, cancels like the sidebar button, no fee. It doesn't explicitly name alternatives (e.g. reschedule_booking for moving a booking) or state when not to use it, so it falls short of the top tier.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_bookingCreate bookingA
Start a new booking as a copy of an existing one: same customer, service and price.
Copies the booking as Duplicate in its sidebar does. The copy is saved as a draft (list_drafts) with the same customer, address, service, extras and price; open form_url to pick the date and book it. Nobody is told until it is booked.
| Name | Required | Description | Default |
|---|---|---|---|
| from_booking_id | Yes | Booking to copy, from list_bookings. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations only declare the safety profile (non-read-only, open-world, non-idempotent, non-destructive); the description adds the behavior that actually matters: the record lands as a draft, not a confirmed booking, and no notification is sent until it is booked. It also discloses the required UI handoff via form_url, which is not visible anywhere in the schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core action, then the draft/notification consequence, then the form_url step — every sentence carries information. The parenthetical reference "Copies the booking as Duplicate in its sidebar does" is slightly awkward and could be tightened, but nothing is wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description still tells the agent what comes back (a draft found via list_drafts plus a form_url to complete the booking) and what state change occurred (nothing notified). For a one-parameter, open-world mutation tool this covers everything needed to invoke and follow up correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single property is already documented as "Booking to copy, from list_bookings," so the baseline is 3. The description earns an extra point by enumerating exactly what is inherited from that id (customer, address, service, extras, price), telling the agent what the copy will contain.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Opens with a specific verb+resource ("Start a new booking") and immediately scopes the mechanism: a copy of an existing booking carrying the same customer, service and price. It draws a direct analogy to the Duplicate sidebar action, which lets an agent distinguish it from siblings like reschedule_booking or cancel_booking without opening any schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Clearly states the trigger condition (you want a new booking that reuses an existing one's customer/service/price) and names the required follow-through: open form_url to pick a date. It points to list_drafts and list_bookings as the relevant companions. It stops short of stating when NOT to use it (e.g., an existing booking should be rescheduled rather than copied), so 4 rather than 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_customerCreate customerADestructive
New customer in the store. BookingKoala emails them an invitation to set a password.
Adds a customer as Add Customer in the admin does, with an optional address that becomes their default service address. BookingKoala emails the customer at once to set a password for the store's booking page, so use their real address. An email already in the store is refused. Returns the new customer as get_customer does.
| Name | Required | Description | Default |
|---|---|---|---|
| apt | No | Apartment or suite. | |
| city | No | City. | |
| Yes | Email address. BookingKoala sends the customer an invitation to set a password. | ||
| phone | No | Phone number, digits only for US numbers, e.g. 2125550147. | |
| state | No | State, e.g. New York. | |
| gender | No | Gender, optional. | |
| address | No | Street address, e.g. 540 W 28th Street, New York, NY, USA. | |
| country | No | Country, e.g. United States. | |
| zipcode | No | ZIP or postal code. | |
| last_name | Yes | Last name. | |
| first_name | Yes | First name. | |
| sms_notifications | No | Text the customer booking updates. Default: false. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover write, open-world, non-idempotent, and destructive hints. The description adds important behavior beyond annotations: an immediate password-invitation email, the need for a real email address, refusal of duplicate emails, the optional address becoming the default service address, and the return shape.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is front-loaded and appropriately sized, with the creation action followed by side effects, constraints, and return behavior. There is some redundancy: the password-invitation email is mentioned in both the first and third sentences, and the phrase 'as Add Customer in the admin does' is awkward.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 12-parameter mutation with no output schema, the description covers the action, key side effect, duplicate constraint, default-address behavior, and return shape. It does not address authentication, permissions, or reversibility, but it is otherwise complete enough to call correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents all 12 parameters. The description adds real semantic meaning for email (must be real because an invitation is sent; duplicates are refused) and address (becomes the default service address), which goes beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific action and resource: 'Adds a customer as Add Customer in the admin does' and 'New customer in the store.' It references get_customer only for return shape, not as a sibling alternative, so sibling differentiation is limited.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied: use this when adding a new customer as the admin's Add Customer does. It provides a relevant constraint that an existing email is refused, but does not explicitly state when to use this versus get_customer, list_customers, or create_booking.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
dashboardDashboardARead-onlyIdempotent
Store totals for a date range: revenue, provider pay, bookings, ratings, referrals.
Returns the figures of the admin Dashboard for the dates given (this month by default): revenue paid and pending, split into bookings, custom invoices and separate charges; what providers earned and what is still unpaid; booking counts, unassigned and cancelled included; ratings and referrals. Amounts are in the store's currency.
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | YYYY-MM-DD, included. Default: last day of this month. | |
| start_date | No | YYYY-MM-DD. Default: first day of this month. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive and openWorld, so the safety bar is low. The description still adds real value beyond them: default date window (this month), inclusive end date semantics, which revenue states are reported (paid vs pending, earned vs unpaid), and that amounts are in the store's currency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the one-line summary before the detailed enumeration. There is mild redundancy — the metrics listed in the first sentence are re-enumerated in the second — but the structured expansion into revenue/provider/booking/rating buckets is useful rather than wasteful.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the burden of describing return values and does so thoroughly across four metric families. Only minor gaps remain (per-item breakdowns, whether zero-activity dates appear), which are unlikely to affect an invocation decision for a two-optional-param read tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% — both start_date and end_date already document the YYYY-MM-DD format and their defaults. The description's 'this month by default' merely restates the schema defaults and adds no new parameter-level detail, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific resource (store totals / admin Dashboard) and enumerates the metrics returned — revenue, provider pay, bookings, ratings, referrals — plus a breakdown into bookings, custom invoices and separate charges. That clearly separates it from the entity-listing siblings (list_bookings, list_charges, list_invoices), though it never names a sibling explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied rather than stated: 'Returns the figures of the admin Dashboard for the dates given (this month by default)' tells the agent it is a reporting call with optional dates, but there is no explicit 'use this when you want aggregates, use list_* when you want line items' guidance or any exclusion.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_bookingGet bookingARead-onlyIdempotent
One booking with its price breakdown, provider pay, notes and service.
Reads a booking by id: date and arrival window, customer, address, assigned providers, the service parameters and extras, notes, the price breakdown (service total, discounts, tax, tip, final amount) and what the providers are paid for it.
| Name | Required | Description | Default |
|---|---|---|---|
| booking_id | Yes | Booking id from list_bookings. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive and open-world, so the safety profile is covered; the description earns credit by enumerating exactly what the response contains (arrival window, providers, price breakdown fields, provider pay). It does not mention permissions or rate limits, but for a read tool that is a minor gap.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded summary sentence followed by one elaborating paragraph listing returned fields. Structure is good, though 'price breakdown' and provider pay are restated across the two sentences, a small redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the burden of explaining return content and does so thoroughly — customer, address, providers, service parameters, notes, price components and provider pay. It lacks an explicit pointer to list_bookings for enumeration, which is the only notable gap for a 1-parameter read tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single parameter already documents 'Booking id from list_bookings', so the schema does the heavy lifting. The description adds only 'by id' framing, which is already implied by the required booking_id field — baseline 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Reads a booking by id') and the leading line 'One booking with its price breakdown...' makes clear this returns a single record, implicitly distinguishing it from list_bookings. It stops short of explicitly naming the list sibling as the alternative, so sibling differentiation is inferred rather than stated.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: an agent gathers it should call this when it has a booking id. There is no explicit when-to-use, when-not-to-use, or naming of alternatives such as list_bookings for enumeration.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_customerGet customerARead-onlyIdempotent
One customer: contact details, addresses, booking counts and bookings not charged yet.
Returns the customer's profile as their page in the admin shows it: name, email, phone, saved addresses (address_id is what a booking or invoice for this customer uses), counts of upcoming and cash bookings, the bookings not charged yet (past ones included), gift cards received and the referral summary. Times of day are in the store's time zone.
| Name | Required | Description | Default |
|---|---|---|---|
| customer_id | Yes | customer_id from list_customers. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover read-only, idempotent, open-world, and non-destructive behavior. The description adds substantial context beyond annotations: it itemizes returned fields, notes that uncharged bookings include past ones, and clarifies that times are in the store's time zone.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is front-loaded with a one-customer summary, then useful detail. There is some repetition between the first sentence and the 'Returns...' sentence, and the second sentence is long, but there is no empty filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema exists, so the description must carry return semantics; it does by listing contact fields, addresses, booking counts, uncharged bookings, gift cards, referral summary, and time zone. It stops short of describing the response shape or not-found behavior, so it is not fully exhaustive.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description does not elaborate on customer_id beyond identifying the customer; the schema's 'from list_customers' is the only usage hint.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a single customer and enumerates the profile content, so the resource and scope are unambiguous. The singular 'One customer' separates it from list_customers, even though no sibling is explicitly named.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit when-to-use or when-not guidance in the description, and no sibling tool is named for comparison. The required customer_id plus the schema note 'from list_customers' implies a lookup after listing, but the description itself gives no selection criteria.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_providerGet providerARead-onlyIdempotent
One provider or team: contact, category, team members, reviews and payment logs.
Returns the provider's profile as their page in the admin shows it: contact details, IC or W2 category, priority, scheduling permissions, the team's members and lead (for a team) or the teams it belongs to, customer reviews and the newest payment logs (what the store paid the provider). Payment logs come as BookingKoala records them.
| Name | Required | Description | Default |
|---|---|---|---|
| provider_id | Yes | provider_id from list_providers (a team too). | |
| payment_logs_limit | No | Newest payment logs to include, 1 to 50. Default: 20. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, openWorld and non-destructive, so the safety profile is covered. The description adds genuine context beyond that: it explains the data scope mirrors the admin provider page, clarifies team-vs-member shape ('the team's members and lead (for a team) or the teams it belongs to'), and notes payment logs are raw BookingKoala records. It does not mention permission requirements or behavior for an invalid id.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The summary clause is front-loaded before the detailed enumeration, so an agent skimming gets the gist immediately. The second sentence is long but every clause names a distinct returned data category. Minor redundancy between 'contact' in sentence one and 'contact details' in sentence two.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description bears the burden of describing return content and does so thoroughly across contact, category, priority, permissions, team structure, reviews and payment logs. Gaps remain around review pagination or limits, error behavior for unknown ids, and whether payment logs are a truncated subset. Adequate but not airtight.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, documenting provider_id (including that it can be a team) and payment_logs_limit with its 1-50 range and default. The description adds only marginal reinforcement by reiterating that team members and payment logs are included. Baseline 3 applies since the schema carries the parameter semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening line states a specific verb and resource ('One provider or team') and enumerates the facets returned: contact, category, team members, reviews, payment logs. It implicitly contrasts with list_providers by fetching a single entity, though it never names that sibling. An agent knows what the tool returns but must infer the single-vs-list distinction from the schema rather than the prose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied by 'provider_id from list_providers' in the schema and by the singular 'One provider', so the retrieve-by-id-after-listing pattern is inferable. However, the description states no explicit when-to-use or when-not conditions and names no alternative such as list_providers for bulk retrieval. Minimum viable guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_bookingsList bookingsARead-onlyIdempotent
Bookings of the store: upcoming, unassigned, completed, charge pending or declined.
Lists bookings as the Bookings page shows them, newest schedule dates first within the filter, with the customer, address, assigned providers, total and whether it is charged. Filter by status, date range, a search on the customer, or one customer or provider. Cancelled bookings are not listed. Page with next_cursor.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Page size. Default: 20. | |
| cursor | No | next_cursor from the previous call. | |
| search | No | Customer name, email or phone. | |
| status | No | Which bookings: upcoming (default), today, unassigned, completed, pending (charge pending), declined (charge declined), paused or all. | |
| end_date | No | Up to this date. | |
| start_date | No | From this date. | |
| customer_id | No | Only this customer's bookings. | |
| provider_id | No | Only this provider's bookings. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the read-only and idempotent annotations, the description discloses ordering ('newest schedule dates first within the filter'), returned content (customer, address, assigned providers, total, charged status), a key exclusion (cancelled bookings are not listed), and pagination behavior ('Page with next_cursor'). These are meaningful behavioral traits an agent needs in order to invoke and interpret the tool correctly.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loads the resource scope before listing ordering, filters, exclusions, and pagination. The opening status fragment is slightly redundant with the schema enum, but it does not materially bloat the definition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For an eight-parameter listing tool with no output schema, the description supplies enough context about what is returned, how results are ordered, what is excluded, and how pagination works. Combined with the annotations and fully documented schema, an agent has what it needs to call the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already documents all eight parameters at 100% coverage, including defaults, formats, and enum meanings, so the baseline is 3. The description reinforces the filter categories but adds little parameter-level detail beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that this tool lists bookings and scopes the resource with statuses, ordering, included fields, filters, and an exclusion for cancelled bookings. It is distinguishable from mutation siblings like create_booking or cancel_booking, but it does not explicitly contrast itself with read siblings such as get_booking.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied by phrases like 'as the Bookings page shows them' and by the available filters, which tells an agent this is the list-oriented read tool. However, there is no explicit when-to-use guidance versus get_booking or other list tools, and no stated when-not-to-use conditions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_chargesList chargesARead-onlyIdempotent
Charged bookings with their payments and refunds, as the Charges page lists them.
Returns bookings that were charged, newest first, each with its payments: the booking charge, extras, tips, fees and refunds, with amount, tax, refunded amount and card. Filter by booking day and search by customer. BookingKoala gives no total: next_cursor is set while a full page comes back. booking_id and payment_log_id go to refund_charge. Empty until the store charges through a connected payment processor or marks bookings paid in cash.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 1 to 100. Default: 20. | |
| cursor | No | next_cursor from the previous call. | |
| search | No | Customer name, email or phone, or a booking id. | |
| end_date | No | Last booking day, YYYY-MM-DD. Default: no upper bound. | |
| start_date | No | First booking day, YYYY-MM-DD. Default: no lower bound. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare read-only/idempotent, and the description adds genuinely non-obvious behavior: ordering ('newest first'), the absence of a total, and pagination termination semantics ('next_cursor is set while a full page comes back') — a quirk that would otherwise cause an agent to stop paging early. The empty-result precondition explains a confusing zero-row outcome.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loads the resource and return shape, then filters, then pagination and empty-state caveats — a sensible order with essentially no filler. The second sentence is long and comma-chained, but every clause carries information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the return-shape burden and does so well: nested payments with amount, tax, refunded amount and card, plus ordering and cursor semantics. It stops short of naming the response envelope or the per-page default, but nothing critical to a correct call is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so limit, cursor, search and the date bounds are already documented. The description only restates the filters in prose ('Filter by booking day and search by customer') plus the cursor hint, adding little syntax or edge-case detail beyond the schema; baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Opens with a specific verb and resource ('Charged bookings with their payments and refunds') and immediately scopes it to charged bookings only, which separates it from list_bookings and list_invoices. It also enumerates the sub-resources returned (charge, extras, tips, fees, refunds), so an agent knows exactly what kind of row this returns.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives concrete selection context: filter by booking day, search by customer, and an explicit empty-state condition ('empty until the store charges through a connected payment processor or marks bookings paid in cash'). It also routes to a sibling ('booking_id and payment_log_id go to refund_charge'), though it never explicitly contrasts with list_bookings or list_invoices.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_customersList customersARead-onlyIdempotent
Customers of the store, with email and phone; search by name, email or phone.
Returns the store's customers as the Customers page lists them, newest first, active or deactivated. BookingKoala gives no total: next_cursor is set while a full page comes back. Use customer_id in get_customer.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 1 to 100. Default: 20. | |
| cursor | No | next_cursor from the previous call. | |
| search | No | Part of a name, email or phone number. | |
| status | No | active or inactive (deactivated) customers. Default: active. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations only cover the safety profile (readOnly/idempotent/non-destructive), while the description adds non-obvious behavior: results are newest-first, include both active and deactivated records by default, no total count is available, and next_cursor is only set when a full page comes back. That pagination-termination rule is exactly the kind of detail an agent cannot infer from the structured fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences, front-loaded with what is returned, then ordering and pagination caveats, then the sibling handoff. No redundant restatement of the title or schema.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
There is no output schema, yet the description still conveys the return shape (customer records with email and phone), ordering, default status scope, and how paging ends. For a zero-required-parameter list tool that is everything needed to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with limit range, cursor source, search semantics and the status enum all documented inline, so the schema carries parameter meaning. The description only echoes the search fields and the active/deactivated notion, adding no syntax or format detail beyond the schema; baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States the resource (the store's customers) and what it carries (email and phone), plus the search fields, which is a specific verb+resource framing. It also distinguishes itself from the get_customer sibling by naming the handoff key: "Use customer_id in get_customer."
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly routes downstream detail lookups to get_customer and explains the active/deactivated default, so the agent knows which tool to pick for a single record. It does not mention create_customer as the alternative for adding a customer, but that is a low-ambiguity gap for a list tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_draftsList draftsARead-onlyIdempotent
Draft bookings and quotes saved in the store, not yet booked.
Lists the drafts and quotes on the Drafts page: customer, date when set, total and whether it is a quote. create_booking leaves a draft here. Page with next_cursor.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Page size. Default: 20. | |
| cursor | No | next_cursor from the previous call. | |
| search | No | Customer name or email. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover readOnly, idempotent and non-destructive, so the description's added value is the field-level payload (customer, date set, total, quote flag) and the paging contract via next_cursor. It does not discuss ordering, date-range limits, or whether a search narrows across both drafts and quotes.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three compact sentences with no filler; the definition and scope come first, then contents, then paging. The leading noun-phrase fragment is slightly awkward as an opener but the information density is high.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only list tool with no output schema, the description names the returned fields and explains how items arrive here, which is what an agent needs to decide to call it. Missing filtering semantics and ordering, but nothing that would cause a wrong invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so limit, cursor and search are already fully documented in the schema. The description only echoes the cursor paging ('Page with next_cursor') and says nothing about the search parameter matching customer name or email, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific resource (draft bookings and quotes) and its scope ('saved in the store, not yet booked'), which separates it from list_bookings in the sibling set. A fragment opener followed by a concrete enumeration of the Drafts page contents makes the purpose unmistakable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explains provenance ('create_booking leaves a draft here') and clarifies the not-yet-booked state, which implicitly routes booked records to list_bookings. It never names list_bookings as the alternative explicitly, so the exclusion is inferred rather than stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_invoicesList invoicesARead-onlyIdempotent
Invoices of the store or of one customer, with payment status, total and amount due.
Returns invoices as the Invoices page lists them, newest first: number, customer, booking or custom type, payment status (paid, unpaid, partially_paid, void, uncollectible), total, paid, amount due, issue and due dates. Filter by customer, payment status and issue dates (default: two years back to a year ahead), or search by number, email, name or phone. BookingKoala gives no total: next_cursor is set while a full page comes back. invoice_id goes to resend_invoice.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | 1 to 100. Default: 20. | |
| cursor | No | next_cursor from the previous call. | |
| search | No | Invoice number, customer email, name or phone. | |
| end_date | No | To this issue day, YYYY-MM-DD. Default: a year ahead. | |
| pay_status | No | Payment status filter. | |
| start_date | No | From this issue day, YYYY-MM-DD. Default: 2 years ago. | |
| customer_id | No | Only this customer's invoices. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already grant read-only, idempotent, non-destructive status, so the description adds the genuinely non-obvious parts: newest-first ordering, the default date window, and the 'BookingKoala gives no total: next_cursor is set while a full page comes back' pagination quirk. That last clause is exactly the kind of behavior an agent would otherwise get wrong.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the one-line purpose, then a dense second paragraph covering return fields, filters and pagination. Nearly every clause earns its place, though the 'BookingKoala gives no total' phrasing is slightly opaque and the field list packs a lot into one sentence.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the return-value burden and does so by enumerating the fields returned (number, customer, type, status, total, paid, amount due, dates). Combined with ordering, pagination and routing hints, an agent has enough to call it and to read the result, though edge cases like empty results go unstated.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents limit, cursor, dates, pay_status enum, customer_id and search. The description restates the default date window and search fields but adds no syntax or format detail beyond the schema, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Opens with a specific verb+resource and scope: invoices for the whole store or a single customer, with payment status, totals and amount due. That scope statement alone lets an agent separate it from list_charges and list_drafts without opening a schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Spells out the three filter axes (customer, payment status, issue date range), the free-text search targets, and the default two-year-back/one-year-ahead window, which is real usage guidance. It also routes the invoice_id it returns to resend_invoice. It stops short of naming when a sibling like list_charges is the better call.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_providersList providersARead-onlyIdempotent
Providers (cleaners, technicians) and teams of the store, in priority order.
Returns the store's service providers as the Providers page lists them, single providers and teams together; type team returns teams only. A team lists its members' provider ids, a provider the teams it belongs to and leads. BookingKoala gives no total: next_cursor is set while a full page comes back. Use provider_id in get_provider and when assigning a booking.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | all: providers and teams (default). team: teams only. | |
| limit | No | 1 to 100. Default: 20. | |
| cursor | No | next_cursor from the previous call. | |
| search | No | Part of a name, email or phone number. | |
| status | No | active or inactive (deactivated) providers. Default: active. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds genuinely useful behavior: results come in priority order, BookingKoala returns no total, and next_cursor is only set while a full page comes back. It also discloses the returned relationship shape (a team lists member provider ids; a provider lists teams it belongs to and leads).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three tight sentences with the resource and ordering stated up front, followed by return shape and then pagination caveat. The opening is a noun fragment rather than a clause, a small readability cost, but no sentence is wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema and five optional parameters, the description carries the return-shape burden well: it explains mixed provider/team results, team membership fields, ordering, and the missing-total pagination quirk. Only the absence of any guidance on the search/status filters in prose keeps it below complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the enum/limit/cursor/search/status semantics are fully described in the schema itself. The description only echoes the 'type team returns teams only' behavior already in the enum description, adding marginal value, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (list) and resource (providers/teams) with scope: 'the store's service providers ... single providers and teams together'. It also disambiguates the 'team' mode and routes the agent to get_provider, so it is distinguishable from siblings without opening any schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives clear context for use ('as the Providers page lists them') and names the downstream consumer ('Use provider_id in get_provider and when assigning a booking'). It does not explicitly say when NOT to use it versus another listing tool, but no sibling lists providers, so the gap is minor.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
reschedule_bookingReschedule bookingADestructive
Postpone a visit of a recurring booking to the date of a later visit in its schedule.
Works like Postpone in the booking's sidebar: the visit moves to one of the schedule's later visit dates, keeping its arrival time and price, and the booking comes back as get_booking shows it. A date outside the schedule fails with the list of allowed dates. One-time bookings cannot be postponed. Nobody is told unless notify is true. A store that charges a reschedule fee refuses the move here: charge it in the panel.
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | New date: one of the later visit dates of the booking's recurring schedule. | |
| notify | No | Email the customer and providers about the change. Default: false. | |
| booking_id | Yes | Booking id from list_bookings. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Adds substantial context beyond the annotations: arrival time and price are preserved, the response matches get_booking, an invalid date returns the allowed-date list, one-time bookings are rejected, and no notification is sent unless notify is true. It also discloses the fee-charging-store refusal, which is operationally important for a destructive mutation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core action, then dense supporting facts in short clauses: behavior, error case, eligibility, notification, and fee exception. No sentence is redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Although there is no output schema, the description explains the return value ('the booking comes back as get_booking shows it') and covers the significant failure modes and side effects. For a mutation tool with three parameters, nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description reinforces the date constraint and the notify default ('Nobody is told unless notify is true'), but adds little syntax or meaning beyond what the schema already documents.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a precise verb and resource ('Postpone a visit of a recurring booking') plus the scope restriction (must move to a later visit date in the schedule). This is clearly distinct from siblings like cancel_booking, create_booking, or get_booking, and an agent can select it without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives clear conditions and exclusions: only recurring bookings, only dates already in the schedule, and fee-charging stores must use the panel instead. It does not explicitly name sibling alternatives (e.g., cancel_booking or create_booking) for the cases it rejects, which keeps it just short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
resend_invoiceResend an invoiceADestructive
Send an invoice to its customer again by email, text or both.
Sends an existing invoice from list_invoices to its customer again, as the invoice's Resend button does: by email (default) and, with sms true, a text with the invoice link. The invoice's CC and billing addresses get the email too. attach_pdf defaults to the invoice's own setting. The invoice itself does not change. The customer gets it at once. BookingKoala refuses some resends with a warning, for example a void invoice; the error carries its message.
| Name | Required | Description | Default |
|---|---|---|---|
| sms | No | Text the invoice link to the customer. Default: false. | |
| No | Email the invoice to the customer. Default: true. | ||
| attach_pdf | No | Attach the PDF to the email. Default: as the invoice. | |
| invoice_id | Yes | invoice_id from list_invoices. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes well beyond the annotations (readOnly=false, destructive=true, idempotent=false, openWorld=true): it discloses that the invoice record itself is unchanged, that CC and billing addresses also receive the email, that delivery is immediate, that attach_pdf follows the invoice setting, and that some resends fail with a warning whose message is carried in the error. That is exactly the side-effect and failure information an agent needs before invoking an irreversible external send.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core action, then ordered from mechanism to side effects to failure modes; every sentence carries information. It is on the dense side and repeats a few schema defaults (email default true, attach_pdf default), which is minor waste.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description covers side effects, timing, and error behavior well, but says nothing about what a successful response contains. Given the tool's simplicity and the presence of annotations, this is a small residual gap rather than a blocking one.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and each parameter already documents its default, so the description's restatement of email/sms/attach_pdf defaults adds little. The one genuine addition is that the email also reaches CC and billing addresses, but that is about effect rather than parameter meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource+mechanism ('Send an invoice to its customer again by email, text or both') and anchors it to the 'Resend button' behavior. It also identifies the source of the input ('an existing invoice from list_invoices'), separating it from sibling tools like send_quote and list_invoices.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives clear context for when to use it (re-sending an already-existing invoice rather than issuing a new one) and notes that certain invoices, such as void ones, will be rejected. It does not explicitly name when to prefer a sibling tool or state exclusions beyond the void example, so it falls short of full routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
send_quoteSend a quoteADestructive
Email a saved quote to the customer with a link to book it.
Sends a quote from list_drafts as the Send quote popup does: saves the recipient and expiry date on the quote, then emails the store's Send quote template (or your subject and message) with the quote's booking link. email defaults to the quote's customer; expires_on to the saved date, else a month ahead. Only drafts saved as quotes can be sent; a plain draft is refused before you confirm. The customer gets the email at once.
| Name | Required | Description | Default |
|---|---|---|---|
| No | Send to this address. Default: the quote's customer. | ||
| message | No | Email body (HTML allowed). Default: the store's Send quote template. | |
| subject | No | Email subject. Default: the store's. | |
| draft_id | Yes | Id of a quote from list_drafts. | |
| expires_on | No | Last day the customer can book it, YYYY-MM-DD. Default: as saved, else a month ahead. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond annotations, the description discloses the side effects: it saves the recipient and expiry date on the quote, emails the store template or supplied subject/message, and sends immediately. It also explains the failure mode for non-quote drafts. These details are consistent with readOnlyHint=false, openWorldHint=true, idempotentHint=false, and destructiveHint=true.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core action and remains reasonably concise. It repeats some schema-provided defaults, which is useful but slightly redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutating, non-idempotent email action with full schema coverage and no output schema, the description covers the important context: what is sent, what is saved, defaults, preconditions, and immediate delivery. Nothing essential for correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents every parameter and its default. The description restates the key defaults for email and expires_on but adds little parameter meaning beyond what is already in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: email a saved quote to the customer with a booking link. It also identifies the source collection, list_drafts, and distinguishes sendable quotes from plain drafts, so an agent can tell exactly what this tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives a clear precondition: only drafts saved as quotes can be sent, and a plain draft is refused before confirmation. It does not explicitly compare against all sibling tools such as resend_invoice, but the quote-specific context is strong.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
17 tool updates
v1.0.1- First observed
assign_provider - First observed
cancel_booking - First observed
create_booking - First observed
create_customer - First observed
dashboard - First observed
get_booking - First observed
get_customer - First observed
get_provider - First observed
list_bookings - First observed
list_charges - First observed
list_customers - First observed
list_drafts - First observed
list_invoices - First observed
list_providers - First observed
reschedule_booking - First observed
resend_invoice - First observed
send_quote
TDQS
Scored across 17 tools
Each tool targets a distinct resource or action: booking lifecycle actions (cancel, reschedule, assign), customer/provider CRUD-style reads, invoice/draft sends, and dashboard reporting are clearly separated. The two sending tools target different objects (invoice vs. quote draft), so they should not be confused.
Nearly all tools follow a snake_case verb_noun pattern (list_bookings, get_customer, create_booking, resend_invoice). The only deviation is dashboard, which is noun-only, so the convention is predictable but not perfectly uniform.
Seventeen tools is slightly above the typical 3-15 range but reasonable for a booking-admin domain spanning bookings, customers, providers, invoices, charges, drafts, and reporting. Each tool maps to a recognizable resource or action rather than feeling padded.
Read coverage is broad, but lifecycle coverage is uneven: there are no update operations for customers, bookings, or providers, no create-booking-from-scratch path, and no invoice or charge creation. Most critically, list_charges explicitly points to refund_charge, which is not present, creating a dead end for refund workflows.
Maintenance
Related MCP Connectors
Let AI agents query data and act across all your business apps via MCP.
Hosted MCP server for Cliniko — patients, appointments, availability, and invoices for AI agents.
AI agent platform: manage leads, conversations, bots, calendar and CRM via MCP.
184 MCP tools for field-service CRM, scheduling and double-entry accounting. Hosted; BYO agent.
Related MCP Servers
- AlicenseNot gradedqualityCmaintenanceProvides AI agents with 220+ tools for building websites, sending email, managing contacts, invoicing, databases, automation, and more through a single secure connection. Features hardware-bound authentication and works with Claude Desktop, Claude Code, Cursor, and other MCP-compatible clients.MIT
- AlicenseAqualityBmaintenanceEnables AI assistants to read and manage a Jobkeepr field service business including jobs, customers, scheduling, estimates, invoices, and payments via MCP.19MIT
- AlicenseAqualityAmaintenanceMCP server for the Housecall Pro API, letting AI assistants read and write Housecall Pro data—customers, jobs, invoices, estimates, scheduling, and more—through natural language.494 npmMIT
- AlicenseNot gradedqualityAmaintenanceEnables any MCP-compatible AI agent to drive your own Chrome browser with your existing login state, filling forms, clicking elements, fetching data, and handling captchas without API keys or re-authentication.338 npm483MIT