Skip to main content
Glama

List invoices

list_invoices
Read-only

Lists invoices with status (open, paid or cancelled), kind, amount in cents and the service each belongs to. Paginated: pass next_cursor from the previous response as cursor.

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
kindNopurchase, renewal, topup, upgrade, custom, wallet_topup or white_label
limitNoPage size, 1 to 100. Default 25.
cursorNonext_cursor from the previous page
statusNoopen, paid or cancelled
service_idNoOnly invoices for this service ID (a UUID)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / kind / description
      Previous value: -"purchase, renewal, topup, custom, wallet_topup or white_label"New value: +"purchase, renewal, topup, upgrade, custom, wallet_topup or white_label"
    • changedInput schema / properties / kind / enum
      Previous value: -[
      -  "purchase",
      -  "renewal",
      -  "topup",
      -  "custom",
      -  "wallet_topup",
      -  "white_label"
      -]New value: +[
      +  "purchase",
      +  "renewal",
      +  "topup",
      +  "upgrade",
      +  "custom",
      +  "wallet_topup",
      +  "white_label"
      +]
  2. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false and destructiveHint=false, so safety is covered. The description contributes the pagination contract (pass next_cursor from the previous response as cursor), which is genuinely useful beyond the annotations, but says nothing about default page size, ordering, or total counts.

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?

Two sentences, front-loaded with the resource and returned fields, then the pagination rule. No filler, though the status enumeration duplicates the schema verbatim and could be dropped.

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 usefully names the return shape (status, kind, amount in cents, service) so the agent knows what it gets back. Missing only ordering and page-size defaults, which are minor given the schema documents limit's bounds and default.

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?

Schema description coverage is 100%, so all five parameters including both enums are already documented, which sets the baseline at 3. The description only restates the status values and repeats the cursor semantics already in the schema, adding no new meaning.

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 ("Lists invoices") and enumerates the returned fields, so the agent knows it is a collection read. It does not name the sibling get_invoice to draw the single-vs-list contrast explicitly, which keeps it 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?

Usage is only implied by the nature of a list operation; there is no statement of when to choose this over get_invoice (single invoice) or how to combine filters. The pagination instruction is practical but is mechanics, not selection guidance.

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.