Skip to main content
Glama

listInvoices

Read-onlyIdempotent

listInvoices: List invoices for the authenticated user with optional status filtering and pagination. Requires authentication.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoZero-based page number for pagination, default 0.
sizeNoNumber of invoices per page, default 20.
statusNoFilter by invoice status: DRAFT, PENDING, PAID, CANCELLED, or OVERDUE.
sessionKeyNoSession key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / page / description
      Added value: +"Zero-based page number for pagination, default 0."
    • addedInput schema / properties / size / description
      Added value: +"Number of invoices per page, default 20."
    • addedInput schema / properties / status / description
      Added value: +"Filter by invoice status: DRAFT, PENDING, PAID, CANCELLED, or OVERDUE."
  2. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds the authentication requirement and authenticated-user scope, which is useful but does not detail result shape or pagination behavior beyond schema.

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, front-loaded sentences with no filler. The main action and scope appear immediately, followed by the prerequisite authentication note.

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 simple list operation with fully documented optional parameters and annotations covering read-only/idempotent behavior, the description is complete. The authentication requirement is stated, and no critical information is missing.

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 coverage is 100%, so parameters are fully documented in the schema. The description only restates that status filtering and pagination are optional, adding no new semantic meaning beyond the schema.

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 action ('List') and resource ('invoices'), scoped to 'the authenticated user', with optional status filtering and pagination. This clearly distinguishes it from sibling tools like getInvoiceDetails and getInvoiceStatistics.

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?

Provides clear context: list invoices for the authenticated user, with optional filters and pagination, and requires authentication. It does not explicitly name alternatives or when-not-to-use conditions, but the usage context is unambiguous.

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.