Skip to main content
Glama

list-invoices

Read-only

List a company's sales invoices from Osome invoicing, newest first. Returns invoices with status, recipient, dates, line items, totals and document links, plus page and perPage. Use get-overdue-invoices or get-invoice-pending-summary for receivables from the accounting ledger, and preview-invoice to read one invoice.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, starting at 1 (default 1).
searchNoLeave unset: Classic's invoice list currently rejects this parameter, so the call fails. Filter with status instead.
statusNoOnly include these statuses (any match): draft, awaiting (sent, not yet due), overdue (sent and past due), paid or cancelled.
perPageNoInvoices per page (default 100).
companyIdYesCompany ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / properties / page / description
      Added value: +"Page number, starting at 1 (default 1)."
    • addedInput schema / properties / perPage / description
      Added value: +"Invoices per page (default 100)."
    • addedInput schema / properties / search / description
      Added value: +"Leave unset: Classic's invoice list currently rejects this parameter, so the call fails. Filter with status instead."
    • addedInput schema / properties / status / description
      Added value: +"Only include these statuses (any match): draft, awaiting (sent, not yet due), overdue (sent and past due), paid or cancelled."
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds useful behavioral context: results are 'newest first' and include status, recipient, dates, line items, totals, document links, plus page and perPage. It does not mention auth needs, rate limits, or pagination edge cases, but its added value over the annotations is solid.

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 sentences with no waste. The primary purpose, return content, and sorting rule are front-loaded, and the alternative-tool routing follows immediately. Every sentence 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?

With no output schema, the description appropriately explains the return shape: invoices with status, recipient, dates, line items, totals, document links, plus page and perPage. Combined with the 100% schema coverage and complete annotations, an agent has enough information to select and invoke the tool correctly.

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 the schema already documents all five parameters in detail, including the important search caveat. The description adds no parameter-specific meaning beyond what the schema provides. Baseline 3 applies when the schema carries the parameter burden.

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 uses a specific verb and resource: 'List a company's sales invoices from Osome invoicing, newest first.' It also distinguishes this tool from siblings by naming what it is not for: 'get-overdue-invoices or get-invoice-pending-summary for receivables from the accounting ledger.' An agent can tell it apart from those tools without opening a 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?

It explicitly routes the agent to alternatives: 'Use get-overdue-invoices or get-invoice-pending-summary for receivables from the accounting ledger, and preview-invoice to read one invoice.' This gives both when-to-use and when-not-to-use guidance with named siblings.

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