Skip to main content
Glama

create-credit-note

Create a draft credit note for an issued invoice instead of deleting the invoice.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
companyIdYesCompany ID
invoiceIdYesInvoice ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare this is a non-read-only, non-destructive, non-open-world write operation. The description adds that the result is a draft and that it serves as an alternative to deletion, which is useful context, but it does not disclose permissions, side effects on the original invoice, or what the draft entails.

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?

A single front-loaded sentence with the verb first and zero wasted words. It is appropriately sized for a simple two-parameter creation tool.

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?

Given the simple schema, full parameter coverage, and annotations that cover the safety profile, the description supplies the key missing context: it creates a draft for an issued invoice rather than deleting it. It does not explain follow-up steps or the resulting draft's lifecycle, but no output schema exists and the core invocation requirements are covered.

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 both parameters are already documented in the schema. The description mentions the invoice implicitly but adds no format, constraint, or meaning beyond what the schema provides.

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 (Create) and resource (draft credit note) scoped to an issued invoice. The word 'draft' distinguishes it from the sibling submit-credit-note, and 'instead of deleting the invoice' differentiates it from a deletion operation.

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?

Provides clear context for when to use it: to address an issued invoice without deleting it. It names deleting the invoice as the alternative, but does not explicitly name sibling tools like submit-credit-note or get-credit-note, nor does it state when not to use this tool.

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.

Resources