Skip to main content
Glama
Sign In
Tradify MCP server

Tradify MCP server

by cotletdev
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

Get invoice

get_invoice
Read-onlyIdempotent

Retrieve a complete invoice by ID to review its status, customer, jobs, quote origin, line items, totals, amounts due, and payment details.

Instructions

Full invoice: lines, tax, totals, every payment with date and method, amount due, jobs and quote.

Returns one invoice: status (draft, approved, overdue, paid, cancelled), customer, its jobs, the quote it came from and how (entire_quote, quote_line_items, percentage, fixed, remaining), reference, description, invoice and due dates, whether it was sent, its lines, subtotal, tax, total, paid, credited and due, and each payment with date, amount, method and reference.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "invoice_id": "<invoice_id>"
    },
    "name": "get_invoice"
  }
}

Input Schema

NameRequiredDescriptionDefault
invoice_idYesInvoice ID from list_invoices.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.0.3

TDQS

A3.7/5.0
Behavior4/5

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 then adds real value beyond them by disclosing the returned content in detail, including the status enum (draft, approved, overdue, paid, cancelled), the payment fields, and the quote-origin modes (entire_quote, quote_line_items, percentage, fixed, remaining). It does not mention behavior for an unknown ID (error/not-found), which keeps it out of 5 territory.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The scope is front-loaded in a short clause, followed by a single dense enumeration of contained fields. Every listed item carries information since there is no output schema. The second sentence is long but not padded with filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description must carry return-shape information, and it does so thoroughly, covering statuses, dates, totals, payments and provenance. The remaining gap is error and not-found behavior, plus no pointer to the list tool that supplies the identifier.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is a single parameter and the schema documents it fully ('Invoice ID from list_invoices'), giving 100% coverage. The description adds nothing about invoice_id format or source. Baseline 3 applies when the schema already does the work.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource ('Full invoice'), then enumerates exactly what the resource includes (lines, tax, totals, payments, amount due, jobs, quote). It is unmistakably a single-record fetch. It does not explicitly contrast with siblings like list_invoices or get_quote, so it falls just short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The leading word 'Full' and 'Returns one invoice' imply this is the deep-detail companion to list_invoices, which is the intended usage. But no sentence states when to use it versus list_invoices or get_quote, and there are no exclusions or prerequisites. Usage 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.

Deploy Server

Other Tools