Skip to main content
Glama
lazyants

lexware-mcp-server

by lazyants

Download Credit Note File

lexware_download_credit_note_file
Read-onlyIdempotent

Download a credit note as PDF, or request the XRechnung XML e-invoice when available.

Instructions

Download the file for a credit note. Defaults to PDF; pass format="xml" to request the XRechnung XML e-invoice when available (the API returns whatever representation it can render).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesCredit note UUID
formatNoRepresentation to request: "pdf" (default) or "xml" for the XRechnung XML e-invoice when available.pdf

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.0.0
    • addedInput schema / properties / format
      Added value: +{
      +  "default": "pdf",
      +  "description": "Representation to request: \"pdf\" (default) or \"xml\" for the XRechnung XML e-invoice when available.",
      +  "enum": [
      +    "pdf",
      +    "xml"
      +  ],
      +  "type": "string"
      +}
  2. First observedv3.0.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already indicate the tool is read-only, idempotent, and non-destructive. The description adds valuable behavioral context: it defaults to PDF, and if XML is requested but unavailable, the API returns whatever representation it can render. This explains fallback behavior beyond what annotations provide.

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 highly concise with two sentences. The first sentence states the core action, and the second sentence adds critical format details. No extraneous information; every word 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?

Given the tool's simplicity (2 params, no output schema) and annotations covering safety/idempotency, the description adequately explains the key behavior (format fallback). It could mention what the tool returns (e.g., file blob) but the absence is not critical since the sibling tools and API pattern imply a file download.

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?

The input schema provides 100% coverage with descriptions for both parameters. The description adds meaning by explaining the purpose of the 'format' parameter (XRechnung XML e-invoice) and its behavior when the requested format is not available. This enriches the schema 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 clearly states the action ('Download the file for a credit note') and specifies the resource (credit note). It distinguishes from sibling tools like download_invoice_file by focusing on credit notes specifically. The format options (PDF default, XML for XRechnung) are explicitly mentioned.

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 explains when to use this tool (to download a credit note file) and provides context for the format parameter (when to request XML). It could be improved by explicitly stating when not to use it or mentioning alternatives like download_invoice_file, but the sibling context and the description itself make the intended use clear.

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