Skip to main content
Glama

List invoices

crunch_list_invoices
Read-only

List sales invoices newest first with number, customer, dates, status, amounts and outstanding balance. Filter by client or status, paginate, or fetch all pages to review receivables.

Instructions

List sales invoices, newest first: number, customer, dates, status, amounts and outstanding balance. Filter by client, or by status (which fetches every page and filters here). Paged (up to 200 per page); use all=true to fetch every page.

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": "crunch_list_invoices"
  }
}

Input Schema

NameRequiredDescriptionDefault
allNoFetch every page (up to max_items) instead of a single page
rawNoReturn the full objects from the API instead of compact summaries (larger)
pageNoPage to fetch, starting at 0 (default 0)
sizeNoResults per page, up to 200 (default 50)
sortNoSort order as field,asc or field,desc, for example postingDate,desc
limitNoMaximum number of items
fieldsNoKeep only these fields (dot paths, such as supplier.companyName)
searchNoCase-insensitive substring match on any value
statusNoOnly invoices with this status, as shown in the status field (for example DRAFT); fetches all pages and filters them here
client_idNoOnly this client's invoices (see crunch_list_clients)
max_itemsNoWith all=true, stop after this many results (default 1000, at most 10000)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuinely useful behavior beyond that: the default ordering (newest first), the page-size ceiling of 200, and the cost implication of the status filter scanning all pages. It stops short of describing result shape or how paging interacts with limit/max_items.

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?

Three short sentences with the payload fields first, followed by filtering options and then the paging strategy. No filler, no restatement of the tool name, and the cost caveat on status filtering is placed where it matters.

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?

For an 11-parameter, output-schema-less list tool, the description covers the primary workflow and the non-obvious paging/filtering tradeoffs. A few power parameters (raw, fields, search, max_items) are left entirely to the schema, which is acceptable given full schema coverage but leaves the description slightly short for a tool this configurable.

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 baseline is 3 and the schema already explains every parameter in detail. The description restates the 200-per-page cap (duplicating size) and adds the useful default sort of newest-first, but says nothing about raw, fields, search, sort, limit, or max_items, so the added meaning is thin relative to the schema.

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?

Opens with a specific verb and resource ('List sales invoices') and enumerates the fields returned (number, customer, dates, status, amounts, outstanding balance), which lets an agent separate it from detail tools like crunch_get_invoice. It never names a sibling explicitly, so the differentiation is implicit 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete usage context: filter by client, filter by status, and use all=true to retrieve every page. It also warns that status filtering fetches every page and filters locally, which helps an agent pick behavior deliberately. No explicit when-not-to-use or named alternative tool is provided.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools