Skip to main content
Glama

List invoices and payments

officernd_list_payments
Read-only

List billing documents — invoices, credit notes, overpayments — with totals, paid/pending amounts, due dates and status. Filter by member, company, location, document type, status, number and issue/due date (e.g. overdue invoices). OfficeRnD: GET /payments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sortNoSort expression <field>:asc|desc, e.g. createdAt:desc.
limitNoPage size, 1-50 (OfficeRnD's max; default 50).
memberNoOnly items for this member _id.
numberNoExact document number.
statusNoOne or more statuses, e.g. paid, pending.
companyNoOnly items for this company _id.
locationNoOnly items for this location _id.
due_beforeNoOnly documents due before this date (ISO 8601 date-time, e.g. 2026-01-01T00:00:00.000Z).
cursor_nextNoThe cursorNext from the previous page. Omit for the first page.
cursor_prevNoThe cursorPrev from a page, to go one page back.
issued_fromNoOnly documents issued at or after this date (ISO 8601 date-time, e.g. 2026-01-01T00:00:00.000Z).
document_typeNoDocument type.
issued_beforeNoOnly documents issued before this date (ISO 8601 date-time, e.g. 2026-01-01T00:00:00.000Z).
modified_sinceNoOnly items modified at or after this time (ISO 8601 date-time, e.g. 2026-01-01T00:00:00.000Z).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, but the description adds valuable non-annotation context: the returned fields (totals, paid/pending amounts, due dates, status) are disclosed despite there being no output schema. It does not mention auth needs, rate limits, or pagination semantics beyond cursor params in the schema.

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 dense but front-loaded sentences with no wasted filler; the document scope comes first, filters second. The trailing 'OfficeRnD: GET /payments' is a minor endpoint breadcrumb that earns little but does no harm.

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 a 14-parameter read-only list tool with no output schema, the description covers the resource scope and the returned field set, which is what an agent needs to select and interpret it. Pagination and cursor behavior are delegated to well-documented schema fields, so nothing critical 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 description coverage is 100%, so all 14 parameters are already documented. The description names the filterable fields and adds an example ('overdue invoices') that maps the date filters to a real scenario, but adds no syntax or format detail beyond the schema. Baseline 3 is appropriate.

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 verb ('List') and resource ('billing documents — invoices, credit notes, overpayments'), enumerating the document types so it is clearly distinguishable from siblings like list_contracts or list_memberships. An agent knows exactly what set of records this returns.

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 clear usage context by enumerating filterable dimensions and an example use case ('overdue invoices'), which tells the agent when this tool is appropriate. It stops short of naming alternatives or when-not-to-use conditions, but no sibling overlaps this billing-document resource.

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.