Skip to main content
Glama

list_invoices

List invoices, newest first. Filter by status (Draft, Sent, Paid, Overdue, Void) and/or clientId.

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
pageNo
statusNo
clientIdNo
pageSizeNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full burden. It does disclose the sort order (newest first), but says nothing about pagination behavior despite page/pageSize parameters — default page size, whether an out-of-range page errors or returns empty, or whether a total count is returned is all undisclosed for a paged read endpoint.

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?

Two short sentences, no filler, with the ordering fact and the filter options front-loaded. Every clause carries information an agent needs.

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

Completeness3/5

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

Four optional parameters, no annotations, no output schema — the description covers filtering and order but is silent on pagination semantics and on what a result entry contains. Adequate to make a first call, insufficient for an agent to page correctly or know it has exhausted results.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate, and it only partially does. It enumerates five status values but omits "Partial," which the enum accepts, and it gives no meaning at all for page or pageSize beyond their names, leaving half the parameters undocumented in both places.

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?

States a specific verb and resource ("List invoices") plus a default ordering ("newest first"), which is enough to distinguish it from create_invoice, get_invoice, and send_invoice by name. It stops short of explicitly naming a sibling or contrasting scope, so sibling differentiation is inferred rather than stated.

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?

"Filter by status and/or clientId" implies the intended usage pattern (narrow a list by status or client), but there is no explicit when-to-use vs. when-not, no mention of when to prefer get_invoice for a single record, and no guidance on paging through results.

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