Skip to main content
Glama

Lightspeed Retail (R-Series) MCP by usefulapi

List purchase orders

lightspeedrseries_list_purchase_orders
Read-only

Purchase orders to vendors: orderID, vendorID, shopID, orderedDate, arrivalDate, receivedDate, complete, totalQuantity, shipCost. GET /Account/{accountID}/Order.json.

Input Schema

NameRequiredDescriptionDefault
sortNoSort field; prefix "-" for descending. Allowed: orderID, timeStamp.
limitNoRecords per page (1-100, default 100).
shop_idNoOnly orders for this shop (shopID).
archivedNofalse (default) = active records only, true = active and archived, only = archived only.
completeNotrue = completed orders only, false = open orders only.
next_urlNoTo get the next page: the next_url value from a previous call of this same tool, unchanged. Other filters are ignored when it is set.
vendor_idNoOnly orders to this vendor (vendorID).
include_linesNoInclude the OrderLines relation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safe-read profile is covered. The description adds the underlying endpoint path, which is mildly useful context, but says nothing about pagination limits, default ordering, or how archived/complete filtering interacts with results — all behavioral details an agent would benefit from.

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 fragments with zero filler, and the resource is front-loaded before the endpoint. It is efficient, though the terseness tips into under-specification rather than economy.

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

Completeness3/5

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

With eight optional parameters and no output schema, the field enumeration is a reasonable stand-in for describing return shape, and the schema fully documents inputs. But the description omits pagination behavior and the relationship to get_purchase_order, leaving gaps an agent must resolve by opening the schema and guessing.

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%, including enum values and the next_url continuation rule, so the schema carries the parameter burden. The description's field list (orderID, vendorID, shopID, etc.) partially maps to filterable concepts like vendor_id and shop_id but adds no syntax or constraint detail beyond the schema. Baseline 3 applies.

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

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description identifies the resource ('Purchase orders to vendors') and enumerates the returned fields, plus the endpoint GET /Account/{accountID}/Order.json, which implies retrieval. However it is a noun phrase with no explicit verb and never states that it returns a paginated list, so the purpose is inferable rather than stated. It also does nothing to distinguish itself from the sibling lightspeedrseries_get_purchase_order.

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?

There is no guidance on when to use this list tool versus get_purchase_order, nor any mention of filtering strategy, paging, or the next_url continuation flow described in the schema. The agent must infer all selection logic from the tool name alone.

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.