Skip to main content
Glama

Unleashed Software MCP by usefulapi

List sales orders

unleashed_list_sales_orders
Read-only

List sales orders, filtered by status, customer, order number, warehouse or date range. Deleted orders are excluded unless asked for. Unleashed: GET /SalesOrders/{page}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (1-based). Default 1.
endDateNoOrders dated on/before this date (YYYY-MM-DD).
pageSizeNoRecords per page, 1-1000. Unleashed default is 200.
startDateNoOrders dated on/after this date (YYYY-MM-DD).
customerIdNoOnly orders for these customer Guids (comma-separated).
orderNumberNoOnly the order with this number (overrides other filters).
orderStatusNoComma-separated statuses, e.g. Parked,Placed,Backordered,Completed.
serialBatchNoInclude serial and batch numbers on lines.
customerCodeNoOnly orders whose customer code starts with this.
modifiedSinceNoOnly records created or modified since this UTC date (YYYY-MM-DD).
warehouseCodeNoOnly orders from this warehouse.
completedAfterNoOrders completed after this date (YYYY-MM-DD).
completedBeforeNoOrders completed before this date (YYYY-MM-DD).
customOrderStatusNoA custom order status (overrides orderStatus).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=true, so the description adds real value by disclosing that deleted orders are excluded by default and by citing the underlying paginated endpoint GET /SalesOrders/{page}. It does not describe rate limits, page limits, or result volume, which keeps it from a 5.

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 compact sentences, front-loaded with purpose then filters, followed by the API mapping. Nothing is wasted, though the trailing 'unless asked for' clause is unexplained and slightly undermines the crispness.

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 14-parameter, fully-schema-documented read-only list tool with no output schema, the description covers scope, filtering, and default exclusion of deleted records. The main omission is any hint about pagination defaults or result-set size, which the endpoint reference only partially compensates for.

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 every one of the 14 parameters is already documented with format and range details. The description only mirrors the filter categories at a high level and adds no syntax or interaction semantics (e.g. how orderNumber overrides other filters) beyond what the schema states.

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?

States a specific verb and resource ('List sales orders') and enumerates the filterable dimensions (status, customer, order number, warehouse, date range), which clearly separates it from the singular get_sales_order sibling. It stops short of explicitly naming the alternative tools like unleashed_get_sales_order or unleashed_list_sales_quotes.

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?

The filter enumeration implies when the tool is appropriate, and the exclusion of deleted orders gives useful context. However, no alternatives are named and no when-not guidance is given; 'unless asked for' is also ambiguous because no parameter in the schema lets the caller request deleted orders.

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.