Skip to main content
Glama
claygeo
by claygeo

List sales orders

distru_list_orders
Read-only

Retrieve sales orders filtered by status, date range, product, or order number. Track order progress from pending to delivered and reconcile with Distru ERP.

Instructions

List sales orders (GET /public/v1/orders). Status is one of PENDING, PROCESSING, READY_TO_SHIP, DELIVERING, DELIVERED, COMPLETED, CANCELED. Totals are decimal strings. New status values may be added over time, so handle unknown tokens rather than assuming this list is closed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsNo
pageNo1-indexed page number. Page size is not guaranteed stable; follow next_page instead.
statusesNo
company_idsNoBuyer company relationship ids.
product_idsNoRestrict to orders containing any of these products.
order_numberNoSubstring match on order number.
order_numbersNoExact match on any order number.
order_datetimeNoComma-delimited datetime range. "T," = on or after T; ",T" = on or before T; "A,B" = between A and B inclusive. Format: YYYY-MM-DDTHH:MM:SS.MSZ.
updated_datetimeNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already provide readOnlyHint and openWorldHint, and the description adds concrete behavioral detail beyond them: totals are decimal strings and status values are not a closed set. This materially helps an agent avoid parsing mistakes and future breakage. No contradiction with annotations.

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 compact and front-loaded with the core operation, then adds only high-value caveats: status tokens, decimal-string totals, and open-world status handling. Every sentence earns its place and there is no redundant boilerplate.

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 list endpoint with nine optional filters and no output schema, the description covers the most important non-obvious details: allowed statuses, decimal-string totals, and open-world status handling. It doesn't describe the full response shape or default ordering, but the schema's page and datetime documentation plus annotations cover most invocation needs.

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 67%, and the schema already documents most parameters well, including page semantics, datetime ranges, and filter meanings. The description adds no parameter-specific detail beyond the status enum, which is already in the schema, so it contributes little beyond the structured input description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/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 sales orders' with the endpoint GET /public/v1/orders. It is clearly a collection-level read operation, though it does not explicitly differentiate itself from the sibling distru_get_order beyond the natural list-vs-single distinction.

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

Usage Guidelines3/5

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

Usage context is implied by the 'List' verb and the sibling tool names, but the description never states when to choose this over distru_get_order or other sibling tools. It gives helpful operational context about statuses and open-world values but no explicit when/when-not guidance.

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