Skip to main content
Glama
lazyants

lexware-mcp-server

by lazyants
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Pursue to a Credit Note

lexware_pursue_credit_note
Destructive

Create a credit note from a preceding invoice, choosing draft or finalized status to reduce the invoice open amount.

Instructions

Create a new credit note from an invoice via POST /credit-notes?precedingSalesVoucherId={id}[&finalize=true]; finalize=true finalizes the credit note, false or omitted creates a draft. In introduction, lineItems[].description, and remark, use only Lexware formatting: bold, italic, and dash-prefixed list items separated by newlines.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesCredit note JSON body with voucherDate, address, lineItems, totalPrice, and taxConditions. In introduction, lineItems[].description, and remark, use only Lexware formatting: **bold**, __italic__, and dash-prefixed list items separated by newlines.
finalizeNoWhen true, creates the credit note in finalized status (immediately paid-off, reducing the invoice open amount). When false or omitted, creates as draft. Maps to the documented ?finalize=true query parameter.
precedingSalesVoucherIdYesUUID of the preceding invoice that this credit note is pursued from.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.3.0
    • changedInput schema / properties / body / description
      Previous value: -"Credit note JSON body. Same shape as lexware_create_credit_note. See Lexware API docs for full schema."New value: +"Credit note JSON body with voucherDate, address, lineItems, totalPrice, and taxConditions. In introduction, lineItems[].description, and remark, use only Lexware formatting: **bold**, __italic__, and dash-prefixed list items separated by newlines."
  2. First observedv3.0.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations declare destructiveHint=true, idempotentHint=false, openWorldHint=true, readOnlyHint=false. The description adds key behavioral context beyond this: what finalize=true does (immediately paid-off, reducing the invoice open amount, per the schema description) and that false/omitted creates a draft. This meaningfully informs consequences of the write. It doesn't disclose permissions or reversibility, which is a minor gap.

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?

Front-loaded with the core action and endpoint, followed by the finalize semantics and formatting rules. Two sentences, no filler. The endpoint URL and query-parameter syntax are somewhat technical but useful. Minor verbosity in the formatting clause.

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 complexity (nested body, mutation, no output schema), the description covers the essential behavior: how to finalize, what fields feed free-text, and the formatting rules. It does not describe the body's required top-level keys (voucherDate, address, lineItems, totalPrice, taxConditions) in the description, but the schema already documents these, so this is acceptable.

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 coverage is 100%, so the baseline is 3. The description adds clarifying detail on the finalize parameter's effect and the formatting constraints for free-text fields (introduction, lineItems[].description, remark). The formatting rules are directly relevant to producing a valid body, adding value beyond the schema.

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 (credit note) with the exact source (from an invoice) and even names the endpoint. Clearly distinguished from lexware_create_credit_note (standalone) and lexware_pursue_invoice/delivery_note/dunning by naming 'pursue' and 'invoice' as the preceding voucher.

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?

Explains the finalize=true vs false/omitted distinction, which functions as clear usage guidance. However, it does not explicitly contrast with lexware_create_credit_note or the other pursue_* siblings, so the 'when to use this vs alternatives' is only implied.

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