Skip to main content
Glama

List order documents

order_documents_list
Read-onlyIdempotent

Lists invoices, delivery notes, credit notes, and cancellation invoices for a Shopware order, including document number, type, creation date, and sent status.

Instructions

List the documents generated for one order: invoices, delivery notes, credit notes and cancellation invoices, with document number, type, creation date and whether they were sent. Use document_download to fetch one as PDF. Returns { orderId, orderNumber, total, items[] }.

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": "order_documents_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
orderIdNoOrder UUID
orderNumberNoOrder number as shown to customers

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.11.1

TDQS

A4.3/5.0
Behavior4/5

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

The annotations already declare this as a read-only, idempotent, non-destructive operation, so the description mainly needs to add useful behavioral context. It does so by listing the document types and returned fields, including whether documents were sent, though it does not mention pagination or ordering behavior.

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 front-loaded with purpose and document types, then names the alternative download tool and states the return shape. Every sentence adds useful information with no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only listing tool with full schema coverage and no output schema, the description provides enough context: what is listed, which document types appear, what fields are returned, and where to go for PDFs. Nothing essential for correct invocation is missing.

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 orderId and orderNumber are already documented in the input schema. The description reinforces that the lookup is for a single order but adds no syntax or selection guidance beyond what the schema provides, making the baseline 3 appropriate.

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 states a specific verb and resource: list documents generated for one order. It enumerates the document types (invoices, delivery notes, credit notes, cancellation invoices) and distinguishes the tool from document_download, making its role clear 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 gives clear context by saying the tool lists documents for one order and explicitly directs PDF retrieval to document_download. It does not spell out when to choose orderId versus orderNumber, but that is appropriately left to the schema.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.