Skip to main content
Glama

List invoices

list_invoices
Read-onlyIdempotent

Retrieve invoices newest first with customer, job, due date, total, paid, and amount due; filter by status, customer, or search and paginate with a cursor.

Instructions

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
cursorNonext_cursor from the previous call.
searchNoMatches number, reference or customer.
statusNoapproved (sent, not fully paid; default), overdue, paid, draft, cancelled or all.approved
customer_idNoOnly this customer's invoices (list_customers).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A4.6/5.0
Behavior5/5

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.

Conciseness4/5

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.

Completeness5/5

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.

Parameters4/5

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.

Purpose5/5

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.

Usage Guidelines4/5

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.