Skip to main content
Glama

List invoices

teachworks_list_invoices
Read-only

List invoices with customer, number, dates, status (Saved, Approved, Paid, Void) and totals. Filter by customer, status, invoice date or due date range. GET /invoices.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (1-based, default 1).
due_toNoDue date on or before (e.g. today, to find overdue invoices together with status Approved).
numberNoInvoice number.
statusNo
date_toNoInvoice date on or before.
due_fromNoDue date on or after.
per_pageNoRecords per page (default 20, max 50).
date_fromNoInvoice date on or after.
directionNoSort by id ascending (default) or descending (newest first).
customer_idNoOnly invoices of this customer.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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, so the safety profile is covered. The description adds the returned field set (customer, number, dates, status, totals), the status vocabulary, and the underlying GET /invoices endpoint, but says nothing about pagination behavior or result volume beyond what the schema covers.

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 compact sentences that lead with what the tool lists before the filter axes and endpoint. No filler, though the field/status enumeration is partially redundant with the structured schema.

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 fields returned, and it covers all filter dimensions for a 10-param read-only list tool. The remaining gap is pagination expectation (page/per_page defaults live only in the schema).

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 90%, so the schema already documents each filter's semantics, including the useful due_to overlap hint. The description restates the filter axes and the status enum without adding format or syntax detail, so it stays at the baseline.

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 (List) and resource (invoices) and enumerates the returned fields plus filterable dimensions, which distinguishes it from teachworks_get_invoice for a single invoice. It stops short of explicitly naming the sibling alternative, so it is clear but not fully differentiated.

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?

The description implies usage by listing filter dimensions (customer, status, invoice/due date range), so an agent can infer when to apply it, but there is no explicit when-to-use vs get_invoice guidance and no stated exclusions or prerequisites.

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.