Tradify 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., "@Tradify MCP serverShow me all overdue invoices"
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.
Tradify API and MCP server, self-hosted
A Tradify API and a Tradify MCP server you run on your own computer, in Python, on the session of your own Google Chrome. All 15 Tradify tools we run in production at Cotlet: jobs and job status, customers, quotes with line items, invoices from quotes, quote and invoice email, payments, and the Scheduler.
Tradify has no public API, no API keys, no webhooks and no official MCP server. Its accounting connectors (Xero, QuickBooks, Sage) sync invoices and bills, not jobs, quotes or the schedule. This repo gives you:
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/tradify, with OpenAPI docs at/docs. SetupPython:
call("list_invoices", {"status": "overdue"}), plus 9 ready scripts inexamples/.
It is for technical people who want to run it themselves, for noncommercial use only (license). If you want it running 24/7 on a server, kept working when Tradify changes its web app, for a team or a business, use the hosted version at cotlet.dev.
git clone https://github.com/cotletdev/tradify-api-mcp-server.git && cd tradify-api-mcp-server
python3 -m venv .venv && . .venv/bin/activate && pip install -e .
tradify-mcp connect # reads your Tradify session from Chrome
tradify-mcp call list_jobs
claude mcp add tradify -- "$PWD/.venv/bin/tradify-mcp" mcpContents
Related MCP server: byob
How it works
AI agent (MCP) / script (REST, Python) ──▶ tradify-mcp on your computer ──your cookies──▶ go.tradifyhq.com
▲
tradify-mcp connect ──────┘ reads them once from your Chrome (DevTools Protocol)You sign in to Tradify in your own Chrome at go.tradifyhq.com, the way you always do: username, Continue, password. Tick Keep me logged in.
tradify-mcp connectattaches to that Chrome through the Chrome DevTools Protocol, reads the tradifyhq.com cookies and saves them to~/.config/tradify-api-mcp/session.json, readable by your user only. It never sees or stores your password or a 2-Step code.Every tool call is a request to the
/apithe Tradify web app itself calls, with those cookies, sent with curl_cffi, which copies Chrome's TLS fingerprint. Calls that change something carry the app's antiforgery token, read fresh for each tool run. No headless browser runs.
The session lives in one cookie, SessionId. With Keep me logged in Tradify keeps it for about a month. When Tradify signs you out, the server reads the cookies 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 go.tradifyhq.com. Any Chrome or Chromium works with a debugging port.
macOS, Linux or Windows.
A Tradify account. We build and test with the company owner. An office user sees and does what Tradify lets that user do.
send_quoteandsend_invoiceneed 2-Step Security on the login (Settings > Security), because Tradify blocks quote and invoice email without it.
Install
git clone https://github.com/cotletdev/tradify-api-mcp-server.git
cd tradify-api-mcp-server
python3 -m venv .venv
. .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e .
tradify-mcp --versionWith uv: uv venv && uv pip install -e ., then uv run tradify-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 Tradify 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 at go.tradifyhq.com.
Run:
tradify-mcp connectChrome asks whether to allow the connection. Click Allow.
Saved 6 Tradify cookies to /Users/you/.config/tradify-api-mcp/session.json
Signed in to Tradify as Dan Novak (Northside Plumbing)You can switch remote debugging off again afterwards. Leave it on if you want the server to pick up a new session by itself after Tradify 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 Tradify there once, and connect to it:
# macOS
"/Applications/Google Chrome.app/Contents/MacOS/Google Chrome" --remote-debugging-port=9222 --user-data-dir="$HOME/.chrome-tradify"
# Linux
google-chrome --remote-debugging-port=9222 --user-data-dir="$HOME/.chrome-tradify"
# Windows
"C:\Program Files\Google\Chrome\Application\chrome.exe" --remote-debugging-port=9222 --user-data-dir="%USERPROFILE%\.chrome-tradify"
tradify-mcp connect --cdp http://127.0.0.1:9222A fresh profile is a new device to Tradify, so with 2-Step Security on it asks for a code at sign-in. --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 go.tradifyhq.com, Application > Cookies > https://go.tradifyhq.com, copy the value of SessionId, then:
tradify-mcp connect --token # paste it, input is hidden
# or, without a session file:
export TRADIFY_AUTH_TOKEN=...A pasted cookie is not read again from Chrome. Paste a new one when Tradify signs you out.
Check the session at any time:
tradify-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, and the tools that reach other people (quote and invoice email, Scheduler bookings) are marked so your client asks before running them.
Claude Code
claude mcp add tradify -- /path/to/tradify-api-mcp-server/.venv/bin/tradify-mcp mcp
# read only:
claude mcp add tradify -- /path/to/tradify-api-mcp-server/.venv/bin/tradify-mcp mcp --read-onlyClaude Desktop
~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"tradify": {
"command": "/path/to/tradify-api-mcp-server/.venv/bin/tradify-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.tradify]
command = "/path/to/tradify-api-mcp-server/.venv/bin/tradify-mcp"
args = ["mcp"]Over HTTP
tradify-mcp serve also serves MCP over streamable HTTP at http://127.0.0.1:8787/mcp, for clients that take a URL:
tradify-mcp serve
claude mcp add --transport http tradify http://127.0.0.1:8787/mcpThen ask your agent things like:
New job for Sam Lee at 12 Oak St: replace the hot water cylinder. Book Mike Ross for Thursday morning, about four hours, and email Sam the confirmation.
Quote the bathroom rewire at 14 Elm Rd from my notes: 6 hours on the Standard billing rate, 6 LED downlights at $24 each, one extractor fan at $85. Show me the draft before you send it.
For every quote accepted this week, create a 30% deposit invoice, skip anything under $500 or already invoiced, and send them after I check the list.
Record the bank transfers I paste below against their invoices, then list every invoice still overdue, totalled per customer, oldest first.
REST API
tradify-mcp serve # http://127.0.0.1:8787, MCP at /mcp, docs at /docsEach tool has its own route under /api/v1/tradify, 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/tradify/jobs?status=to_invoice'
curl 'http://127.0.0.1:8787/api/v1/tradify/invoices?status=overdue'
curl 'http://127.0.0.1:8787/api/v1/tradify/appointments?from=2026-10-27&to=2026-10-31'
curl -X POST http://127.0.0.1:8787/api/v1/tradify/invoices/558f2199-6ca6-489e-bfdf-d4d11cd878e3/payments \
-H 'Content-Type: application/json' \
-d '{"amount": 300, "method": "Bank Deposit", "reference": "TRF 20261023"}'Any tool by name, body as its arguments:
curl -X POST http://127.0.0.1:8787/api/v1/tradify/tools/list_customers -d '{"search": "lee"}'GET /api/v1/tradify/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. List tools 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>:
TRADIFY_MCP_TOKEN=$(openssl rand -hex 24) tradify-mcp serve --host 0.0.0.0Python and the example scripts
Straight from Python, no server needed:
from tradify_api_mcp import call
from tradify_api_mcp.scripting import paginate, write_rows
overdue = call("list_invoices", {"status": "overdue"})["invoices"]
week = call("list_appointments", {"from": "2026-10-27", "to": "2026-10-31"})["appointments"]
jobs = list(paginate("list_jobs", {"status": "all"}, "jobs"))
write_rows(jobs, "jobs.csv")
call("update_job_status", job_id="d3bd2e39-af25-4cda-9daf-d9f758f8f0e5", status="complete")Or one tool from the shell: tradify-mcp call list_quotes status=accepted since=2026-10-01, or with a JSON object.
Times are wall clock in your company's time zone (Settings > Company). 2026-10-29T08:00 means 8:00 there. A time with an offset is converted to it, and answers carry the company's offset.
Ready scripts in examples/. Each prints a short list or JSON, takes --out file.csv or --out file.json where it makes sense, and --help. The ones that change Tradify only show their plan until you pass --apply or --send:
Script | What it does |
Every overdue invoice, totalled per customer, oldest first, with the ones past your last reminder marked. A call list. | |
Records the payments of a CSV bank export against invoices by number. Skips an unknown or closed invoice and a payment above the amount due. | |
Records a payment on one invoice and sets its jobs to complete once nothing is due. | |
Finds or adds the caller, creates the job, and with | |
A draft quote from a text file of time and misc lines; | |
A percentage deposit invoice for every quote accepted lately whose job has no invoice yet. | |
Tomorrow's Scheduler grouped by staff member, with job, customer and crew notes. | |
Jobs to CSV or JSON. | |
Every customer to CSV or JSON, with sites. |
python examples/overdue_invoices.py
python examples/deposit_invoices.py --percent 30 --minimum 500
python examples/export_jobs.py --status to_invoice --out to_invoice.csvOn a schedule, cron on your own computer works while it is on: 0 18 * * * cd ~/tradify-api-mcp-server && .venv/bin/python examples/tomorrows_schedule.py.
All 15 tools
IDs come from the list tools: job_id from list_jobs, customer_id from list_customers, quote_id from list_quotes, invoice_id from list_invoices. Staff are named by full name, as on the Scheduler. tradify-mcp tools prints this list, tradify-mcp tools --json adds the input schemas.
Jobs
Tool | Access | REST route | What it does |
| read |
| Jobs with number, customer, site address, status and assigned staff. |
| read |
| Full job: description, site, tasks, notes, appointments, costs, linked quotes and invoices. |
| write |
| New job for a customer. It starts as Unassigned. |
| write |
| Set a status on a job, built-in or one of your custom statuses. |
Customers
Tool | Access | REST route | What it does |
| read |
| Customer profiles with contact details and sites. |
| write |
| New customer profile, optionally with contact details and a physical address. |
Quotes
Tool | Access | REST route | What it does |
| read |
| Quotes with customer, total, quote date, expiry date and status. |
| write |
| Draft quote with line items. Nothing is sent until you call send_quote. |
| write |
| Approve the quote and email it to the customer with a link to accept or decline online. |
Invoices and payments
Tool | Access | REST route | What it does |
| read |
| Invoices with customer, job, due date, total, amount paid and amount due. |
| write |
| Draft invoice from an approved or accepted quote, for all of it or part of it. |
| write |
| Approve the invoice and email it to the customer, with payment reminders if enabled. |
| write |
| Record a payment received against an invoice and reduce the amount due. |
Scheduler
Tool | Access | REST route | What it does |
| read |
| Scheduler appointments in a date range, with staff, job, times and notes. |
| write |
| Book a job appointment on the Scheduler for staff, optionally emailing the customer a confirmation. |
send_quote and send_invoice email the customer. schedule_appointment sends each staff member Tradify's "You've been scheduled" notice, and emails the customer only with email_customer. The other write tools stay inside Tradify. Drafts from create_quote and create_invoice_from_quote reach nobody. record_payment refuses more than the amount due and a draft invoice. Part invoices from a quote (percentage, fixed_amount, line_items) need a plan with progress invoicing, which Tradify sells as Pro.
Not in this version: price list items, kits and quote options (quotes take misc and time lines), reading a quote's lines, editing or deleting a quote, invoice or customer, moving or cancelling an appointment, a staff list, timesheets, costing, bills, purchase orders, enquiries, recurring jobs and forms.
Never built, on purpose: your Tradify sign-in, password and 2-Step Security, and your Tradify plan and billing. Every request passes a guard that refuses any change to the sign-in and account paths of the web app.
Configuration
Variable | Default | What it does |
|
| Folder of |
| The | |
| Proxy for every request to Tradify, e.g. | |
|
| |
| Bearer token required by | |
|
| Address of |
Security and your Tradify account
Your password never reaches this code. Only the cookies Chrome already holds are read, and only those of tradifyhq.com.
The session file is yours.
session.jsonis created with mode 0600. Anyone who has it can act as you in Tradify, so keep it out of git and shared folders.Local by default.
servebinds to127.0.0.1and refuses another address withoutTRADIFY_MCP_TOKEN.tradifyhq.com only. Requests and redirects outside tradifyhq.com are refused.
Read-only mode.
--read-onlyorTRADIFY_MCP_READ_ONLY=1exposes the 6 read tools only.Some actions reach real people. A sent quote or invoice lands in your customer's inbox and cannot be deleted in Tradify afterwards, only cancelled. MCP clients ask before running those tools; a script does not, so try it on a customer with your own email address first.
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 Tradify signed you out. Sign in at go.tradifyhq.com in Chrome and run |
403 |
| Tradify does not let this login do it. For |
403 |
| The server runs read-only, or the request would change your Tradify sign-in. |
403 |
| Tradify refused the request or showed a bot check. Open the web app in Chrome once, then retry. |
409 |
| Tradify asks for a CAPTCHA. Solve it in Chrome. |
422 |
| An argument is missing or wrong; the message names it. |
429 |
| Tradify is limiting the account. Wait a few minutes. |
502 |
| Tradify answered with an error (its own message is in |
Self-hosted or hosted
This repo | ||
Tools | the same 15 | the same 15 |
Runs | on your computer, while it is on | in the cloud, 24/7 |
Tradify session | your Chrome, saved in a local file | your own Cloud Browser in the EU, profile encrypted with AES-256-GCM |
When Tradify changes its web app |
| fixed for you, every tool tested daily |
Approvals | your MCP client asks per call | quote and invoice email and Scheduler bookings 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 noncommercial 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 10 credits, 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 Tradify have an official API? No. Tradify publishes no API, developer docs or webhooks (checked 11 Oct 2026). It connects to other tools through built-in integrations: QuickBooks, Xero, Sage, Stripe and Google Calendar. Details: cotlet.dev/integrations/tradify-api-mcp-server.
Is there a Tradify MCP server for Claude, ChatGPT or Cursor?
Yes, this one runs on your machine: tradify-mcp mcp for Claude Code, Claude Desktop, Cursor and Codex. ChatGPT and Claude.ai connectors need a public HTTPS URL, which the hosted Tradify MCP server gives you.
Can it get my Tradify jobs and invoices into another tool?
Yes. python examples/export_jobs.py --status all --out jobs.csv and python examples/overdue_invoices.py --out overdue.csv write CSV, and the REST API serves the same lists as JSON to n8n or any HTTP client.
Why does send_quote stop with app_permission_denied?
Tradify blocks quote and invoice email until the login has 2-Step Security. Set it up in Tradify under Settings > Security with a mobile number, then call again. The tool stops before it approves anything, so the quote or invoice stays a draft.
Which Tradify plan do I need? The tools do what your plan lets you do in Tradify. Part invoices from a quote need progress invoicing, which Tradify sells as Pro. On the free Tradify Connect plan only the Scheduler works.
Does it work outside the US? Yes. Tradify runs one web app for every country, and the tools read your company's time zone and tax rates from it.
Why does it need my Chrome? To read your Tradify session without your password and without a 2-Step code. Chrome is used once per sign-in, not for each call.
What happens when Tradify 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 tradify-mcp connect again.
Can it run on a VPS or in Docker?
Technically yes, with a pasted cookie or a session.json copied from your computer. Tradify then sees your session from a datacenter IP, which looks less like you. For an always-on setup the hosted version keeps your session in your own Cloud Browser on a fixed IP.
Will my Tradify account get banned? Requests carry Chrome's fingerprint and go out one at a time, as you would click. Nobody can promise a platform never acts. Keep to your normal use.
Can I use it for my trade business or for my clients? No. The license allows noncommercial use only, and running your own business counts as business use. For a trade business, a team or client work, use Cotlet or write to contact@cotlet.dev.
Can I use the code for anything I like? No. The source is public, but the license allows noncommercial use only: no business use.
A tool broke or I need another one. Open an issue with the tool name and the error message.
License
PolyForm Noncommercial License 1.0.0. In short:
Allowed: noncommercial use: you, for your own personal purposes with your own Tradify account, or a charity, school, public research or government body. Changing the code, and sharing it under the same license.
Not allowed: any commercial use, your own business included; client work; selling or offering it, or a service built on it.
Maintained by Cotlet (@cotletdev). Tradify is a trademark of its owner. This project is unofficial and not affiliated with, endorsed or sponsored by Tradify.
Available Tools
15 toolscreate_customerCreate customerAInspect
New customer profile, optionally with contact details and a physical address.
Creates an active customer with the company's default price group, document theme and tax settings, as the New Customer form does. email may hold several addresses separated by commas; quotes and invoices go there. It reaches no one and stays inside Tradify.
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | ||
| name | Yes | Customer or company name. | |
| No | Email for quotes and invoices; commas for more. | ||
| phone | No | ||
| state | No | State or region. | |
| mobile | No | ||
| address | No | Street address. | |
| contact | No | Contact person. Default: the name. | |
| postal_code | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare it as a non-read-only, non-idempotent, non-destructive creation tool. The description adds useful behavior beyond those annotations: it creates an active customer with default price group, document theme, and tax settings, and it clarifies that the email is stored for quotes/invoices but no external message is sent.
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 short and front-loads the core action. However, the final sentence ('It reaches no one and stays inside Tradify') is somewhat vague and could be phrased more directly.
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?
It covers the main creation semantics and important defaults, which is valuable for a 9-parameter create tool with no output schema. It still lacks details on duplicate handling or what the tool returns, leaving meaningful gaps for an agent invoking it.
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 56%, so the schema already documents the key fields, including email and contact. The description restates email behavior and groups contact/address fields, but it adds little detail for city, phone, mobile, or postal_code, leaving several parameters without additional semantic guidance.
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 uses a specific verb and resource: it creates a new customer profile and states that the result is an active customer with company defaults. This clearly distinguishes it from list_customers and from other create_* siblings for jobs, quotes, and 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?
The description implies usage by comparing it to the New Customer form and by explaining that email is used for quotes and invoices, but it does not explicitly say when to use this tool versus alternatives or when not to use it. The guidance is inferable rather than stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_invoice_from_quoteCreate invoice from quoteAInspect
Draft invoice from an approved or accepted quote, for all of it or part of it.
Creates a draft invoice from a quote, as Create Invoice > From Quote does, linked to the quote and its job. mode entire copies every line; line_items copies the lines at the positions in lines; percentage invoices amount percent of the quote total; fixed_amount invoices amount (with tax); remaining invoices what the quote's earlier invoices did not. A part is one line at the quote's tax rate. Due date follows the customer's or your payment terms. The invoice stays a draft until send_invoice. Needs a plan with progress invoicing (Pro) for the part modes.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | ||
| lines | No | line_items: positions of the quote's lines to invoice, 1 for the first. | |
| amount | No | percentage: percent of the quote total (e.g. 50). fixed_amount: amount with tax. | |
| quote_id | Yes | Quote ID from list_quotes. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Adds substantial context beyond the annotations: the created object is a draft (not a finalized invoice), it is linked to the quote and its job, the due date is derived from payment terms, partial invoices inherit the quote's tax rate, and part modes are plan-gated. These are exactly the lifecycle and entitlement facts annotations do not convey.
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 and scope, then a dense but purposeful sentence enumerating modes. The mode enumeration is a run-on list, but every clause maps to a real enum value or constraint, so little 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 does the work of explaining the resulting state (draft, linked to quote and job, derived due date). It never states what identifier or payload is returned, which an agent needs in order to chain into send_invoice, but otherwise covers the call fully.
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 75% and the mode enum has no per-value documentation in the schema, so the description carries real weight: it defines what each of the five modes does and clarifies that `lines` holds 1-based positions and `amount` means a percent or a tax-inclusive figure depending on mode.
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 (draft invoice from a quote) and immediately scopes it: entire quote or a part of it. It is clearly distinguishable from siblings such as create_quote, create_job, and send_invoice, and even anchors to the equivalent UI action (Create Invoice > From Quote).
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 a clear precondition (quote must be approved or accepted), a routing constraint (part modes require a Pro plan with progress invoicing), and an explicit next step (the invoice stays a draft until send_invoice). The agent knows both when to call it and what to call afterwards.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_jobCreate jobAInspect
New job for a customer. It starts as Unassigned.
Creates a job for a customer, as New Job does, and Tradify gives it the next job number. It starts Unassigned; schedule_appointment books staff on it. Contact, phone and site address default to the customer's. It reaches no one and stays inside Tradify.
| Name | Required | Description | Default |
|---|---|---|---|
| contact | No | Job contact. Default: the customer's. | |
| reference | No | Your reference, e.g. a PO number. | |
| customer_id | Yes | From list_customers or create_customer. | |
| description | Yes | What the work is. | |
| site_address | No | Default: the customer's address. | |
| contact_phone | No | Default: the customer's phone. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations cover the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false), and the description usefully adds that each call consumes a new job number (explaining the non-idempotency), that the job begins Unassigned, and that creation sends no notification and stays inside Tradify. This is real context beyond the annotations, though it omits what happens on failure or whether deletions/rollback are possible.
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 short, but the opening 'New job for a customer. It starts as Unassigned.' is restated almost verbatim in the third sentence, wasting the front-loaded position. The fragment style and the unexplained 'as New Job does' also cost clarity.
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 should say what a successful call returns (e.g., the new job's identifier) so the agent can chain into schedule_appointment or get_job. It covers the creation semantics and defaults well but leaves that chaining-critical detail unaddressed.
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 all six parameters are already documented, including the 'Default: the customer's' fallbacks that the description restates. The description adds no field-level meaning beyond what the schema provides, 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 concrete verb and resource (creates a job for a customer) and states the resulting state (starts as Unassigned, Tradify assigns the next job number). It also positions itself against schedule_appointment, which books staff on the created job. The only weakness is the redundant first sentence overlapping with the third, and the cryptic reference to 'as New Job 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?
Usage is implied rather than stated: the agent can infer this is the creation step that precedes schedule_appointment. There is no explicit 'use this when X, not Y' or exclusion such as 'do not use for existing jobs, use update_job_status instead,' so routing must be inferred from the sibling list.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_quoteCreate quoteAInspect
Draft quote with line items. Nothing is sent until you call send_quote.
Creates a draft quote for a customer, as New Quote does. Each line is misc (description, quantity, unit_price) or time (hours at a billing rate; the price comes from the customer's price group unless unit_price is given). Tax uses the default rate, or tax_rate by name; amounts, tax and totals are worked out as Tradify does. job_id links it to a job of the same customer. Expiry defaults to your expiry days setting. Price list items and kits are not supported yet. The quote stays a draft until send_quote.
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | No | Link the quote to this customer's job (list_jobs). | |
| reference | No | Customer reference. | |
| line_items | Yes | ||
| customer_id | Yes | From list_customers or create_customer. | |
| description | No | Shown on the quote. | |
| expiry_date | No | Default: your expiry days setting. | |
| tax_inclusive | No | Prices include tax. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare that it writes and is non-idempotent, and the description adds real context on top: the object stays a draft, tax uses the default rate or a named rate, totals are computed as Tradify does, and price-list items/kits will not work yet. That discloses side-effect boundaries and failure modes an agent could not infer from 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?
The key constraint (nothing sent until send_quote) is front-loaded and the closing sentence reinforces it, so the reader gets the gist in one line. The middle is a dense run-on chain of clauses that could be broken up, but every clause carries distinct 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?
Covers creation semantics, defaults, tax handling, and unsupported features for a 7-parameter create tool with no output schema. The one real gap is that it never says what comes back (presumably a quote ID needed for send_quote), which the agent must infer.
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 already 86%, so baseline is 3; the description adds cross-field logic the schema lacks, notably that job_id must be a job of the same customer, that time-line prices come from the customer's price group unless unit_price is given, and that expiry falls back to a user setting. It does not explain reference, description, or tax_inclusive beyond the schema, which is acceptable.
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 up front ("Draft quote with line items") and immediately distinguishes its scope from send_quote. The related sibling (New Quote / send_quote) is named, so the agent can tell it apart from send_invoice and create_invoice_from_quote.
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 says nothing is sent until send_quote, which tells the agent this is the pre-send step, and it flags unsupported inputs (price list items and kits) as a when-not condition. It does not, however, position itself against create_invoice_from_quote or explain how a draft flows into invoicing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_jobGet jobARead-onlyIdempotentInspect
Full job: description, site, tasks, notes, appointments, costs, linked quotes and invoices.
Returns one job: customer, contact, site address, status, reference and description, the staff on it, its tasks and notes, the Scheduler appointments (times with the company's UTC offset), the costs logged on it (products and misc costs) and the quotes and invoices linked to it. Read it before changing a job.
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | Job ID from list_jobs. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With readOnlyHint and idempotentHint already declaring safety, the description adds valuable return-content transparency: customer, contact, site address, staff, tasks, notes, Scheduler appointments with UTC offset, costs, and linked quotes/invoices. It does not discuss error behavior or permissions, but it substantially exceeds the annotation-level disclosure.
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 a useful summary and then expands into detail. There is some redundancy between "Full job: ..." and "Returns one job: ...", but the overall structure is readable and not excessive.
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 one-parameter read tool with no output schema, the description fully explains what is returned and adds the key workflow instruction to read the job before changing it. No essential calling information appears to be 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%, and the sole parameter is documented as "Job ID from list_jobs." The description does not add parameter-specific meaning beyond the schema, so the baseline score of 3 is appropriate.
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 gives a specific verb/resource ("Returns one job") and enumerates the job data returned, so its purpose is clear. It distinguishes itself implicitly from list_jobs by emphasizing a single full job, though it does not explicitly name siblings.
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 provides one workflow cue: "Read it before changing a job." That is useful context, but it does not explicitly compare this tool with alternatives such as list_jobs or update_job_status, so selection guidance is only partially covered.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_appointmentsList appointmentsARead-onlyIdempotentInspect
Scheduler appointments in a date range, with staff, job, times and notes.
Returns the Scheduler's job appointments that fall between from and to (both days included, at most 31 days), each with its job, customer, staff member, start and end (ISO 8601 with the company's UTC offset), notes and status (accepted, unconfirmed, declined, cancelled). staff keeps only those people, by full name.
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Last day, up to 31 days after from. | |
| from | Yes | First day. | |
| staff | No | Only these staff members, by full name. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent and openWorld, so the description does not need to re-establish safety. It does add genuinely new behavioral facts: the 31-day maximum window, inclusive end-day semantics, ISO 8601 timestamps carrying the company's UTC offset, the enumeration of possible status values, and that the staff filter is a restriction rather than an expansion. The only notable gap is pagination/result-size behavior for a potentially long range.
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 tightly packed sentences with no filler; the purpose and field list come first, followed by the constraints and return shape. The opening is a noun phrase rather than a verb phrase, which is slightly less front-loaded than it could be, 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 fully carries the return contract: entity fields, timestamp format, status vocabulary and filter semantics. Combined with the documented range ceiling, an agent has everything needed to call this 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%, so the baseline is 3. The description nonetheless adds meaning beyond the schema by clarifying that both from and to are included as whole days and that staff narrows results by full name (a filter, not a lookup key).
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 the resource precisely (Scheduler job appointments) and enumerates the returned fields (job, customer, staff, start/end, notes, status), so an agent knows exactly what it is querying. It does not, however, contrast itself with the nearby list_jobs or schedule_appointment siblings, leaving the boundary between 'jobs' and 'appointments' to inference.
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 by the date-range framing; there is no explicit statement of when to call this instead of list_jobs, get_job or schedule_appointment, and no exclusions or prerequisites. An agent can infer it is a read/list operation over a bounded window, but the routing decision is left unstated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_customersList customersARead-onlyIdempotentInspect
Customer profiles with contact details and sites.
Lists customers by name with contact, email (may be a comma list), phone, mobile, physical address and sites. search matches name, contact, email or phone, so use it to find the customer_id before creating a job or quote. archived lists archived customers instead. Pass next_cursor back as cursor.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| cursor | No | next_cursor from the previous call. | |
| search | No | Matches name, contact, email or phone. | |
| archived | No | List archived customers instead. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly/idempotent/openWorld/non-destructive, so the safety profile is covered. The description adds genuine context beyond them: search matches name/contact/email/phone, archived switches the result set, and next_cursor must be passed back as cursor. It does not mention rate limits or default page size, so not a 5.
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?
Tight, two-sentence body where every clause carries information (search scope, downstream use, archived, cursor). The lead fragment 'Customer profiles with contact details and sites' is slightly return-value focused rather than action-focused, 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 carries the burden of describing returns and does so at a summary level (fields, archived variant, cursor pagination). For a four-optional-parameter read tool this is sufficient; only the limit default/maximum behavior is left entirely to the schema.
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 75% — cursor, search and archived are already documented in the schema, and limit is constrained there. The description mostly restates the search match fields and cursor handoff rather than adding syntax or edge-case semantics, 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?
The description pairs the verb 'Lists' with the resource (customers, by name) and enumerates the fields returned (contact, email, phone, mobile, address, sites). It is clearly not one of the write-oriented siblings (create_job, send_invoice), though it doesn't name a specific sibling to contrast with.
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 states the routing use case: 'use it to find the customer_id before creating a job or quote', which ties this lookup to the downstream create_* tools in the sibling set. It also explains the archived toggle and the cursor round-trip. It lacks an explicit 'do not use this when…' exclusion, keeping it 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.
list_invoicesList invoicesARead-onlyIdempotentInspect
Invoices with customer, job, due date, total, amount paid and amount due.
Lists invoices, newest first, with customer, jobs, invoice and due dates, total, paid and due (total minus payments and credits). status approved (default) is every approved invoice not fully paid; overdue is the ones past their due date; paid, draft, cancelled and all as named. customer_id lists that customer's invoices, and status then filters the page you get. Pass next_cursor back as cursor.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| cursor | No | next_cursor from the previous call. | |
| search | No | Matches number, reference or customer. | |
| status | No | approved (sent, not fully paid; default), overdue, paid, draft, cancelled or all. | approved |
| customer_id | No | Only this customer's invoices (list_customers). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the read-only annotations, the description discloses sorting order, computed amount due, pagination flow via next_cursor, and precise filtering semantics for status and customer_id. This gives the agent meaningful behavioral context for invoking 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 dense and front-loads the returned fields, but it repeats the invoice fields in the first two sentences. It remains efficient overall, though 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 read-only list tool with no output schema, the description sufficiently explains returned fields, ordering, filtering, status semantics, and pagination. An agent has enough information 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 coverage is high at 80%, and the description adds useful meaning for status values, default status behavior, customer_id filtering, and cursor pagination. It does not explain the limit or search parameters beyond what the schema provides, so it is strong but not exhaustive.
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 uses a specific verb and resource: it says the tool lists invoices, names the fields returned, and specifies newest-first ordering. It is clearly distinct from sibling list tools such as list_quotes, list_jobs, and list_customers.
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 the default status and the meaning of each status value, and it clarifies how customer_id and status interact. It does not explicitly name when to use an alternative tool, but the usage context for a filtered invoice list is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_jobsList jobsARead-onlyIdempotentInspect
Jobs with number, customer, site address, status and assigned staff.
Lists jobs, newest number first. By default only active jobs (every status marked active, built-in or custom); status all, a built-in status or the name of a custom status narrows it. customer_id lists that customer's jobs, and status then filters the page you get. Pass next_cursor back as cursor.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| cursor | No | next_cursor from the previous call. | |
| search | No | Matches job number, customer or reference. | |
| status | No | active (default), all, unassigned, assigned, scheduled, in_progress, to_invoice, on_hold, complete, cancelled or the name of a custom status. | |
| customer_id | No | Only this customer's jobs (list_customers). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish this as a safe, idempotent, read-only, open-world read, so the description's extra value is in ordering ('newest number first'), the default active-only filter, and cursor-based paging. The ambiguous clause 'status then filters the page you get' hints that filtering happens after the limit is applied, which is a genuinely useful if slightly murky disclosure.
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?
Dense and front-loaded: return fields first, then ordering and default scope, then parameter interactions, then the cursor instruction. The opening sentence is a bare noun-phrase fragment that reads awkwardly, but every clause carries information and nothing is padding.
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 compensates by naming the five returned fields, the sort order, the default filter, and the continuation mechanism. An agent can call this correctly and paginate without needing anything further.
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 80%, so the schema does much of the work, but the description adds real meaning: cursor must be the next_cursor from a prior call, and customer_id composes with status in a way the schema alone does not convey. It says nothing about `search` or `limit`, which is the remaining gap.
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 ('Lists jobs') and immediately enumerates the returned fields (number, customer, site address, status, assigned staff), which tells an agent this is a bulk job listing rather than a single-record fetch. It doesn't explicitly name get_job as the single-record alternative, so sibling differentiation is left implicit.
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 operating context: default is active-only, and 'status all, a built-in status or the name of a custom status narrows it' tells exactly what values do. It also flags the non-obvious combination rule that customer_id plus status filters within the returned page. No explicit when-not guidance or named alternatives, keeping it below 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_quotesList quotesARead-onlyIdempotentInspect
Quotes with customer, total, quote date, expiry date and status.
Lists quotes, newest quote date first, with customer, linked job, total (with tax), quote, expiry and accepted dates and status. By default the quotes awaiting acceptance; expired is the ones awaiting acceptance past their expiry date. since keeps quotes dated on or after that day, so use status accepted with since to find what was won in a period. Pass next_cursor back as cursor.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| since | No | Only quotes dated on or after this day. | |
| cursor | No | next_cursor from the previous call. | |
| search | No | Matches number, reference or customer. | |
| status | No | awaiting_acceptance (default), draft, accepted, expired, cancelled, declined or all. | awaiting_acceptance |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare read-only, idempotent and non-destructive, so the safety profile is covered. Beyond that, the description adds ordering behavior, default status behavior, the definition of 'expired', and the cursor round-trip ('Pass next_cursor back as cursor') — real behavioral context rather than restatement.
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 what it returns and how it sorts, then defaults, then pagination — a sensible order. The opening fragment ('Quotes with customer, total, quote date, expiry date and status.') largely duplicates the following sentence's field list, which is the only real 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 carries the return-shape burden and does so by listing fields and ordering, and it explains pagination. It's nearly complete for a filtered read tool; the relationship between limit/paging behavior and the default result set is left to the schema.
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 80%, so baseline is 3, but the description adds meaning the schema lacks: the default status is awaiting_acceptance, 'expired' is a subset of awaiting_acceptance past expiry, 'since' filters by quote date, and cursor is the previous next_cursor. The remaining gap is limit/search behavior, which the schema covers.
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 ('Lists quotes') and immediately enumerates the returned fields (customer, linked job, total with tax, quote/expiry/accepted dates, status) plus sort order (newest quote date first). That is enough to distinguish it from create_quote, send_quote and create_invoice_from_quote 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?
It explains the default filter ('quotes awaiting acceptance'), clarifies what 'expired' means, and gives a concrete recipe: 'use status accepted with since to find what was won in a period'. It offers no explicit when-not-to-use or sibling routing, so it falls short of the top band, but the usage context is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
record_paymentRecord paymentAInspect
Record a payment received against an invoice and reduce the amount due.
Adds a payment you already received to an approved invoice, as Add Payment does: amount, date, method (by name, from Settings > Payment Methods) and a reference. It charges nobody and emails nobody. The amount cannot exceed what is due; paying it all marks the invoice paid. If an accounting app is connected, Tradify syncs the payment to it.
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | Payment date. Default: today. | |
| amount | Yes | Amount received, at most the amount due. | |
| method | No | Payment method name, e.g. Bank Deposit, Cash, Credit Card. Default: Unknown. | |
| reference | No | e.g. the check number. | |
| invoice_id | Yes | Invoice ID from list_invoices. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes well past the annotations: no charge is made, no email is sent, the amount is capped at the amount due, full payment flips the invoice to paid, and payments sync to a connected accounting app (which explains openWorldHint). This tells the agent exactly what side effects to expect from a non-idempotent 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?
Two tight paragraphs: the first states the action and effect, the second supplies preconditions, limits and side effects. Every sentence carries information and the summary line is front-loaded.
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 mutation tool with no output schema, the description covers preconditions, amount constraints, downstream state changes and external sync. Combined with annotations that already declare safety and idempotency, an agent has 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 coverage is 100%, so all five parameters are already documented including defaults and the invoice_id provenance. The description echoes amount, date, method and reference without adding format or constraint detail beyond what the schema states, 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?
Names a specific verb and resource ('Record a payment received against an invoice') and states the resulting state change ('reduce the amount due'). No sibling tool touches payments, so the boundary is unambiguous from the sentence alone.
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?
Establishes the precondition explicitly - the payment must already be received and the invoice must be approved - and clarifies scope with 'It charges nobody and emails nobody', which implicitly routes charging/notifying to tools like send_invoice. It does not name an alternative tool directly, so it stops 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.
schedule_appointmentSchedule appointmentADestructiveInspect
Book a job appointment on the Scheduler for staff, optionally emailing the customer a confirmation.
Books the job on the Scheduler from start to end for each staff member named (by full name; default the signed-in user), as the Scheduler does. Each staff member gets Tradify's "You've been scheduled" notice, and an Unassigned or Assigned job becomes Scheduled. email_customer also sends the customer the appointment confirmation email, with customer_message in it.
| Name | Required | Description | Default |
|---|---|---|---|
| end | Yes | ISO 8601; without a zone, company time. | |
| notes | No | Notes for the crew. | |
| staff | No | Staff member names, one appointment each. Default: you. | |
| start | Yes | ISO 8601; without a zone, company time. | |
| job_id | Yes | Job ID from list_jobs. | |
| email_customer | No | Email the customer a confirmation. | |
| customer_message | No | Extra text in that email. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already flag mutation, external side effects, destructiveHint, and non-idempotency; the description adds concrete behavior beyond that: each named staff member gets a scheduled notice, an Unassigned or Assigned job becomes Scheduled, and email_customer sends the customer confirmation with customer_message. It still does not disclose duplicate-call behavior or appointment conflict handling.
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 key side effects. It is slightly redundant, since the opening mentions optionally emailing the customer and the second paragraph repeats that email_customer sends the confirmation, but it remains efficient overall.
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 seven-parameter mutation with no output schema, the description covers the important invocation context: defaults, staff expansion, status transition, and external email side effects. It leaves response shape and conflict/idempotency behavior unstated, but those are secondary for correct 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 the schema already documents all seven parameters. The description still adds meaning beyond schema text: staff are named by full name, default to the signed-in user, and receive one appointment each; email_customer controls the customer confirmation; customer_message is included in that email.
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: 'Book a job appointment on the Scheduler for staff.' It clearly distinguishes the action from viewing siblings like list_appointments and from status-only changes like update_job_status by describing start-to-end booking and staff assignment.
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?
The description gives context and defaults, including that staff defaults to the signed-in user and that email_customer is optional. However, it does not explicitly say when to use this instead of siblings such as update_job_status or list_appointments, nor when not to use it, so usage is only implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
send_invoiceSend invoiceADestructiveInspect
Approve the invoice and email it to the customer, with payment reminders if enabled.
Approves a draft invoice (Tradify gives it its number) and emails it from Tradify with the link to view and pay it; payment reminders follow if you enabled them. Without to it goes to the customer's email. Subject and text default to your invoice email template. An approved invoice can be sent again. Tradify sends this mail only when the login has 2-Step Security set up; otherwise the call stops before approving.
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Recipient emails. Default: the customer's email. | |
| message | No | Email text. Default: your invoice template. | |
| subject | No | Default: your invoice email template. | |
| invoice_id | Yes | Invoice ID from list_invoices or create_invoice_from_quote. | |
| send_me_a_copy | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond annotations, it discloses the approval step, email link, payment reminders, default recipient/subject/text, resend behavior, and a hard prerequisite (2-Step Security) that stops the call before approval. This gives the agent a complete behavioral picture.
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 opening sentence front-loads the core action, but the second sentence partially repeats the approval/email flow, adding some redundancy. Overall it remains readable and appropriately sized.
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 state-changing, external-send tool with no output schema, the description covers the key prerequisites, side effects, and defaults. It could mention what a successful call returns or error behavior beyond the 2-Step Security stop, but the gaps are minor.
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 80% and already documents the default behavior for to, message, and subject. The description repeats those defaults but adds no further parameter semantics, and send_me_a_copy remains undocumented in both schema and description.
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 (approve and email) and resource (invoice), including side effects like payment reminders. It does not explicitly differentiate from close siblings such as send_quote, leaving that inference to the agent.
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?
The description implies usage—approve a draft invoice and email it, with resend allowed—but offers no explicit when-to-use or when-not-to-use guidance relative to alternatives like send_quote or record_payment. It does note the 2-Step Security prerequisite, but does not compare alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
send_quoteSend quoteADestructiveInspect
Approve the quote and email it to the customer with a link to accept or decline online.
Approves a draft quote (it becomes awaiting acceptance) and emails it from Tradify with the link where the customer accepts or declines it online. Without to it goes to the customer's email. Subject and text default to your quote email template. An approved quote can be sent again. Tradify sends this mail only when the login has 2-Step Security set up; otherwise the call stops before approving.
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Recipient emails. Default: the customer's email. | |
| message | No | Email text. Default: your quote template. | |
| subject | No | Default: your quote email template. | |
| quote_id | Yes | Quote ID from list_quotes or create_quote. | |
| send_me_a_copy | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare non-read-only, non-idempotent, destructive, open-world, but the description adds what those hints cannot: the state transition to 'awaiting acceptance', that mail is sent from Tradify, that partial failure is possible (the call stops before approving when 2-Step Security is absent), and that repeat sends are permitted despite idempotentHint=false. That is exactly the behavioral context an agent needs before invoking a real-world email 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 action and outcome, followed by the operational details (defaults, re-send, security prerequisite). The second sentence restates the accept/decline link slightly, but that minor overlap is offset by the density of unique information per 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?
For a write tool with no output schema and an external email side effect, the description covers state change, delivery channel, defaults, and the blocking prerequisite. It stops short of describing what the call returns on success or failure, which would complete the picture.
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 80%, so the baseline is 3, and the description usefully explains default resolution for `to` (customer's email), subject, and message (quote email template). It does not explain `send_me_a_copy`, which is undocumented in both schema and description, keeping it below a 5.
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 sentence states a specific verb pair (approve + email) on a specific resource (quote), including the customer-facing accept/decline link. This is unambiguously distinct from siblings like create_quote (drafting) and send_invoice (different document type).
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 concrete preconditions: the quote must be a draft that gets approved, re-sending an already-approved quote is allowed, and sending only works when the login has 2-Step Security set up (otherwise the call aborts before approving). No sibling tool is named as an alternative, but no reasonable alternative exists for this action, so the guidance is effectively complete.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_job_statusUpdate job statusAInspect
Set a status on a job, built-in or one of your custom statuses.
Sets a job's status, as Change Status on the Jobs list does: to_invoice, on_hold, complete, cancelled, the others of the built-in list, or the name of a custom status from Settings > Jobs > Job Statuses (spaces as underscores). It reaches no one, and one more call sets it back.
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | Job ID from list_jobs. | |
| status | Yes | unassigned, assigned, scheduled, in_progress, to_invoice, on_hold, complete, cancelled or the name of a custom status. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Adds real context beyond the annotations: 'It reaches no one' discloses that no notification is sent, and 'one more call sets it back' discloses reversibility, which sharpens the destructiveHint=false/idempotentHint=false signals. Minor gap: nothing about validation failures for unknown custom status names.
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 verb and short enough to scan, but the first two sentences restate the same idea ('Set a status on a job' / 'Sets a job's status'), costing a sentence that could carry new 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?
For a 2-param mutation tool with no output schema and full annotation coverage, the description covers what it changes, how to express custom values, absence of side effects (no notifications), and reversibility. Nothing an agent needs to invoke it correctly 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 baseline is 3; the description earns above that by explaining how custom statuses are spelled ('spaces as underscores') and pointing to Settings > Jobs > Job Statuses as their source, which the schema does not say.
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 ('Set a status on a job') plus the scope (built-in or custom statuses). No sibling tool touches job status mutation, so the description makes the tool's role unambiguous without needing to name a competitor.
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?
Anchors usage to the equivalent UI action ('as Change Status on the Jobs list does'), which tells the agent this is the sole mutation path for status. It does not state prerequisites (e.g. required permissions or whether the job must exist / be in a particular state), so it stops short of explicit when-not guidance.
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.
15 tool updates
v1.0.1- First observed
create_customer - First observed
create_invoice_from_quote - First observed
create_job - First observed
create_quote - First observed
get_job - First observed
list_appointments - First observed
list_customers - First observed
list_invoices - First observed
list_jobs - First observed
list_quotes - First observed
record_payment - First observed
schedule_appointment - First observed
send_invoice - First observed
send_quote - First observed
update_job_status
TDQS
Scored across 15 tools
Each tool targets a distinct resource and action, and the quote/invoice lifecycle is clearly split into create, send, and list operations. The only potentially overlapping pair, create_job and schedule_appointment, is explicitly differentiated: one creates an Unassigned job, the other books staff on it.
All 15 tool names follow a consistent snake_case verb_noun pattern (create_job, list_customers, send_quote, update_job_status, etc.). Even the longer create_invoice_from_quote fits the same convention without breaking predictability.
At 15 tools, the set sits at the top of the well-scoped 3-15 range and each tool maps to a meaningful Tradify operation. There is no obvious filler or redundant tool.
Core workflows are covered: create customers/jobs/quotes/invoices, schedule, send, record payments, and update job status. However, there are notable gaps: no get/update for customers, quotes, or invoices individually, no edit or cancel/delete operations, and no task/note management despite get_job returning tasks and notes.
Maintenance
Related MCP Connectors
Run a service business from chat: clients, jobs, quotes, invoices, payments, expenses.
Job management for service companies: look up, book, tag, assign and note jobs from your AI.
For home service shops on Doing Work: see today's jobs and draft quotes and invoices from chat.
Read, crawl and act on websites, signed in as the user, and turn any site into an API.
Related MCP Servers
- AlicenseNot gradedqualityCmaintenanceLets local AI agents drive the Chrome browser a user already has open, including signed-in sessions, by listing tabs, reading page text and actionable elements, then clicking, filling, selecting, scrolling, navigating, and capturing viewport screenshots without exporting cookies. Runs as a dependency-free local stdio process over Native Messaging, with per-tab leases, automatic reconnection, and pause/write-action controls.MIT
- AlicenseNot gradedqualityAmaintenanceLets AI coding tools drive the real, already-logged-in Chrome browser over local stdio—snapshotting and reading pages, clicking, typing, managing tabs, capturing screenshots, and inspecting network, console, storage, and cookies—without opening a remote-debugging port. It installs as a Chrome extension plus native-messaging bridge, so agents work in the user's authenticated sessions while passing bot detection.1 npmISC
- AlicenseNot gradedqualityAmaintenanceLets AI coding tools drive the real Chrome browser you already have open, so they can read and act on logged-in pages with real clicks, typing, navigation, screenshots, and network or storage inspection. Everything runs locally over stdio with no remote-debugging port, so nothing leaves your machine.1 npmISC
- AlicenseAqualityBmaintenanceEnables AI agents and scripts to read and manage events on your account — guest lists with questionnaire answers, CSV export, check-in, approvals, invites and Text Blasts — through your own signed-in Chrome session, with no public API or official integration required. Runs locally over stdio, streamable HTTP, a REST API with OpenAPI docs, and a Python client.141PolyForm Noncommercial 1.0.0