Skip to main content
Glama

Invoiced MCP by usefulapi

List credit notes

invoiced_list_credit_notes
Read-only

List credit notes: customer, status (draft, open, paid, closed, voided), totals, remaining balance, line items. GET /credit_notes.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, from 1 (default 1). Pass the previous reply's next_page.
sortNoSort, "<column> asc|desc", e.g. "date desc".
filterNoExact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0.
end_dateNoCredit notes dated on or before this date (a bare date includes the whole day).
metadataNoExact-match filters on metadata keys, e.g. {"account-rep": "Jan"}.
per_pageNoResults per page, 1-100 (default 25).
start_dateNoCredit notes dated on or after this date or date-time.
customer_idNoOnly this customer's credit notes.
updated_afterNoOnly records updated after this date or date-time.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered structurally. The description adds the returned field set and the HTTP endpoint but says nothing about pagination behavior, defaults, or result ordering beyond what the schema provides.

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 sentences with zero filler; the resource and returned fields are front-loaded and the endpoint follows compactly. Every clause earns its place.

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 enumerates the returned fields and status values, which compensates well. It falls slightly short by omitting any note on pagination behavior or result limits, though those are largely covered by the schema parameters.

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 nine parameters are documented in the schema itself; the baseline is 3. The description adds no parameter-level detail (e.g. filter syntax or date semantics) beyond what the schema already states.

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 ('credit notes'), and enumerates returned fields including the status value set. It's clearly distinguishable from single-record tools like invoiced_get_credit_note by name and description, though it doesn't explicitly contrast with it.

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?

Usage is implied by 'List' and the GET endpoint, but there is no explicit when-to-use context, no mention of alternatives (e.g. invoiced_get_credit_note), and no stated prerequisites. An agent can infer the intent but gets no routing guidance.

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.