Skip to main content
Glama

get_supplier_document

Get a single supplier document by ID, including its line items (positions) and payments. Use this to read a supplier invoice's positions before copying them to another document type (e.g. converting a supplier invoice to a supplier fiscal receipt). Valid document_type values: supplier_invoice (default), supplier_order, supplier_proforma_invoice, supplier_fiscal_receipt, simplified_supplier_invoice.

Input Schema

NameRequiredDescriptionDefault
idYesSupplier document ID
document_typeNoDocument type (default: supplier_invoice)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It implies a read-only retrieval and discloses the returned payload shape (positions, payments), which is valuable, but says nothing about permissions, error behavior for unknown IDs, or whether related nested data can be large/truncated.

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?

Two sentences plus an enumerated value list, all front-loaded with the action and return contents. Slightly dense, but every clause (return shape, use case, allowed document types) 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?

For a simple 2-parameter read tool with no output schema, the description adequately covers what the call returns and the valid type values. Missing only failure/handling notes, which limits it below a 5.

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 baseline would be 3. The description adds real value by enumerating the valid document_type values (supplier_invoice default, supplier_order, supplier_proforma_invoice, supplier_fiscal_receipt, simplified_supplier_invoice), which the schema does not constrain via enum.

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?

Specific verb+resource ('Get a single supplier document by ID') plus an explicit statement of what is returned (line items/positions and payments). This clearly distinguishes it from the sibling search_* and list_* tools, which retrieve collections rather than one document.

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?

Gives a concrete use case: reading an invoice's positions before copying them to another document type, with a conversion example. It does not explicitly say when NOT to use it (e.g. use search_supplier_invoices for browsing), but the retrieval-by-ID framing makes the boundary clear.

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