Skip to main content
Glama

List credit notes

crunch_list_credit_notes
Read-only

List credit notes for sales invoices, supplier expenses, or both, newest first, including the linked invoice or expense, amount, state, and refunds.

Instructions

List credit notes: those issued against your sales invoices (for=invoices, the default), those from suppliers against expenses (for=expenses), or both (for=all), newest first, with the invoice or expense they belong to, amount, state and refunds. Crunch's public API can't create credit notes; do that in the Crunch app. Reads the invoices that have credits one by one, so it can take a few seconds.

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_credit_notes"
  }
}

Input Schema

NameRequiredDescriptionDefault
forNoinvoices (default: credit notes you issued against sales invoices), expenses (credit notes from suppliers) or all
limitNoMaximum number of items
fieldsNoKeep only these fields (dot paths, such as supplier.companyName)
searchNoCase-insensitive substring match on any value
end_dateNoOnly credit notes dated on or before (YYYY-MM-DD)
start_dateNoOnly credit notes dated on or after (YYYY-MM-DD)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false and idempotentHint=false, so the description doesn't need to restate safety. It adds real context beyond them: newest-first ordering, the fact that each invoice with credits is fetched one by one so calls can take seconds, and that refunds/state accompany each note.

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?

Three sentences, front-loaded with the scope options followed by the creation exclusion and the latency caveat. The middle sentence is long but every clause carries information; no filler or repetition of the title.

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 six optional parameters and no output schema, the description usefully compensates by describing returned content (owning invoice/expense, amount, state, refunds) and the latency profile. Only minor gaps remain, such as how `limit` interacts with the one-by-one fetch and whether sorting is 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 all six parameters are already documented. The description restates the `for` semantics (matching the enum description) and implies ordering, but adds nothing about `limit`, `fields`, `search`, or the date-range parameters, so the baseline 3 applies.

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 names a specific verb and resource ('List credit notes') and immediately disambiguates the three collection scopes (invoices issued, supplier expenses, or all), plus the default. An agent knows exactly what this returns without opening the schema.

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?

It spells out when each `for` value applies and gives an explicit 'when not': credit notes cannot be created via the API, so creation belongs in the Crunch app. What is missing is routing to sibling read tools (e.g. crunch_list_invoices) when an agent actually wants invoice lists rather than credits.

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