Skip to main content
Glama

List invoices

list_invoices
Read-onlyIdempotent

Use this when the user asks to see, find or count their sales invoices: unpaid, overdue, paid, drafts, for a client or a date range ("which invoices are unpaid?"). Lists sales invoices of one business, newest document date first: number, date, due date, status, whether overdue, client name, currency, total, VAT and balance (remaining). status is one of all, draft, sent, overdue, paid, written_off: sent means issued and not yet due; overdue means something is left to pay (remaining above 0) and the due date is before today (UAE time). client_name is the name printed on the invoice; client_current_name appears only when the client was renamed since. On the first page, totals are the invoice list header of the app: count and sum of invoice totals per currency (not balances) of every invoice matching the filter, so with status all they include drafts, which are not issued. No client contact details. Do not use it for one invoice's lines (get_invoice), quotes (list_quotes) or supplier bills (list_bills_due).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_invoices"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoPage size, 1 to 50. Default 20.
cursorNonext_cursor from the previous page, with the same filters.
statusNoOne of all, draft, sent, overdue, paid, written_off. Default all.
date_toNoYYYY-MM-DD, document date on or before.
client_idNoFrom list_clients.
date_fromNoYYYY-MM-DD, document date on or after.
business_idNoFrom list_businesses. May be left out when the connection shares exactly one business.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover read-only, idempotent, non-destructive and closed-world behavior, yet the description still adds substantial context: result ordering, the exact fields returned, the meaning of sent vs overdue including the UAE timezone, and the client_name vs client_current_name rename rule. It also discloses a non-obvious caveat that first-page header totals include drafts and sum totals rather than balances, and that client contact details are absent.

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 trigger and the sibling exclusions are correctly front-loaded and nothing is wasted on restating the name or annotations. It is, however, a single dense paragraph, and the header-totals caveat is verbose enough that it slightly slows scanning for the filter semantics.

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?

With no output schema, the description fully carries the return-value burden by enumerating the listed fields and explaining the totals block. Pagination, filtering and the single-business default are covered between the schema and the description, and edge cases like renamed clients and draft inclusion are noted.

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 100%, so the schema already documents every parameter and the baseline would be 3. The description earns above baseline by explaining what the status values actually mean (sent = issued and not yet due; overdue = remaining above 0 and due date before today in UAE time), which the schema's bare enum list does not convey.

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?

States a specific verb and resource (list sales invoices), the scope (one business, newest document date first) and enumerates the returned fields. It also explicitly distinguishes itself from get_invoice, list_quotes and list_bills_due, so an agent can route correctly without opening the schema.

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

Usage Guidelines5/5

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

Opens with a concrete trigger ('when the user asks to see, find or count their sales invoices') and gives example phrasings plus the filterable dimensions (status, client, date range). It closes with explicit exclusions naming the three sibling tools that handle adjacent requests.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources