Skip to main content
Glama

purchase-order

Credit an invoice

credit_note_create

Credit one invoice: the whole invoice, a GROSS amount_minor split over its VAT rates, or named lines. Amounts store negative, reusing the invoice's own rates. Free: 5 a month. Send it with credit_note_text.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
linesNoCredit only these invoice lines. Leave out with amount_minor for a full credit note
notesNoFree text printed under the totals
reasonYesWhy the money is being given back, e.g. "returned goods" or "billed twice". Printed on the document
invoiceYesThe invoice number to credit, e.g. INV-2026-0001
issue_dateNoYYYY-MM-DD, defaults to today in your business profile's timezone
amount_minorNoCredit this GROSS amount, VAT included, in minor units. Split across the invoice's VAT rates in proportion to each rate's share of the total

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations are all false, so the description carries the behavioral burden. It discloses useful internal behavior: 'Amounts store negative, reusing the invoice's own rates,' which explains storage and VAT handling. It also surfaces the quota 'Free: 5 a month' and the companion workflow with credit_note_text. No annotation contradiction exists.

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?

The description is short and front-loaded. The first sentence immediately states the core action and modes, while each following clause adds distinct value: storage behavior, quota, and the follow-up with credit_note_text. No sentence is wasted.

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 creation tool with six parameters, no output schema, and no useful annotations, the description covers the key decision space: what modes exist, how amounts behave, quota limits, and the intended follow-up action. It does not describe return values or failure behavior, but the schema covers parameter needs and the description provides enough contextual guidance for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/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. The description adds value above the schema by summarizing how the parameters relate: the whole invoice, a GROSS amount_minor split across VAT rates, or named lines. This clarifies the mode-selection semantics beyond individual field descriptions.

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 opens with a specific verb and resource ('Credit one invoice') and then distinguishes the three supported modes: whole invoice, gross amount_minor split over VAT rates, or named lines. This clearly separates credit_note_create from siblings like credit_note_delete, credit_note_get, and credit_note_list.

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?

The description gives clear context for when to use this tool: to credit an invoice in one of three ways. It also provides actionable follow-up guidance by saying 'Send it with credit_note_text.' It does not explicitly state when not to use alternatives or mention exclusions, but the sibling roles are clear enough.

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.