Skip to main content
Glama

Get sales order PDF

get_sales_order_pdf
Read-onlyIdempotent

Retrieve a sales order's PDF as a base64-encoded string. Specify the order ID to download or save the file to a local path.

Instructions

Get sales order PDF.

Download the PDF of a sales order as a base64-encoded string.

[Sales Orders] GET /orders/sales/pdf/{id}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe ID of the sales order.
save_pathNoOptional absolute file path to write the decoded file to. When omitted the file is returned inline as a base64 resource.
administrationNoThe client administration to act on. Only one is configured: default.
Install Server

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already mark the operation as read-only, idempotent, open-world, and non-destructive. The description contributes additional behavioral context by stating the response is a base64-encoded PDF and exposing the REST endpoint; the save_path write behavior is left to the schema, which documents it.

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?

The description is short and front-loads the key purpose and output format. The opening 'Get sales order PDF' sentence is redundant with the title and the endpoint line is optional context, but there is no real bloat.

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 read-only download with fully described parameters and rich annotations, the definition is largely complete: it states output encoding, target resource, and endpoint. There is no output schema, so the return-format statement is essential and present; error behavior is not described, but this is a minor gap.

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 the parameters are already well documented and the description needs to add little. The description does not elaborate on id, save_path, or administration beyond the schema, so the baseline 3 is 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 uses a specific verb ('Download') and resource ('PDF of a sales order') and adds the output encoding ('base64-encoded string'). This clearly identifies the purpose and distinguishes it from sibling PDF tools such as get_sales_invoice_pdf or get_purchase_invoice_pdf by document type.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no when-to-use guidance, exclusions, or alternatives; it never explains when to choose this over a sibling PDF downloader. The purpose sentence implies a use case, but that is not explicit usage guidance.

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

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/vladxyz/informer-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server