Skip to main content
Glama

list_invoices

Read-onlyIdempotent

List invoices with optional filters. Use status "OVERDUE" to find unpaid invoices past due date.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sortNoSort column
limitNoMax results (default 20)
orderNoSort order
searchNoSearch by invoice number, account name, email, or phone
statusNoFilter by invoice status

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesTool result payload — shape varies per tool, see the tool description
summaryYesOne-line human-readable summary of the action
renderTypeYesUI rendering hint for the result

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, covering the safety profile. The description adds minor context about OVERDUE semantics but does not disclose additional behavioral traits such as pagination behavior or default sorting, which are partially present in the schema via the limit parameter.

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

Conciseness5/5

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

The description is two short sentences totaling 17 words, front-loaded with the primary action. The second sentence provides a concrete, actionable example without redundancy or filler. Every word earns its place.

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?

Given the presence of a comprehensive input schema, output schema, and annotations, the description is sufficient. It covers the tool's core purpose and adds a useful filter guideline. No critical information is missing; the schema handles parameter details and the annotations handle safety and idempotency.

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?

The input schema has 100% description coverage for all five parameters, so the baseline is 3. The description adds meaningful value by explaining that OVERDUE means 'unpaid invoices past due date,' which clarifies an enum value beyond the schema's simple 'Filter by invoice status.' This extra semantic helps with correct parameter selection.

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 clearly states 'List invoices with optional filters,' which is a specific verb-resource pair. It distinguishes this from invoice-related siblings like get_invoice (single invoice) and create_invoice/write tools, and the OVERDUE example reinforces the listing scope.

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?

The description provides clear context for using the tool—listing invoices with filters—and gives a concrete use case: using status OVERDUE to find unpaid past-due invoices. It does not explicitly mention alternatives like get_invoice for a single invoice, but the usage context is unambiguous enough to guide an agent.

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.