Skip to main content
Glama

Lightspeed Retail (R-Series) MCP by usefulapi

List sales

lightspeedrseries_list_sales
Read-only

Sales history: saleID, completed/voided flags, completeTime, totals (calcSubtotal, calcTax1/2, total, balance), customerID, employeeID, shopID, registerID. Filter by a date range on completeTime (default) or timeStamp, shop, customer, employee. Set include_lines for SaleLines (items sold). Paginate with next_url. GET /Account/{accountID}/Sale.json.

Input Schema

NameRequiredDescriptionDefault
toNoEnd (inclusive), same format.
fromNoStart (inclusive), e.g. 2026-10-01 or 2026-10-01T00:00:00-04:00. Times are UTC unless an offset is given.
sortNoSort field; prefix "-" for descending. Allowed: saleID, timeStamp, completeTime, updatetime.
limitNoRecords per page (1-100, default 100).
voidedNotrue = voided only, false = exclude voided.
shop_idNoOnly sales in this shop (shopID).
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.
completedNotrue = completed sales only, false = open/unfinished only.
date_fieldNoWhich date from/to apply to (default completeTime).
customer_idNoOnly sales for this customer (customerID).
employee_idNoOnly sales processed by this employee (employeeID).
include_linesNoInclude the SaleLines relation (line items).
include_paymentsNoInclude the SalePayments relation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

readOnlyHint=true is consistent with a read-only listing, and the description adds behavior beyond annotations: the default date field is completeTime, include_lines toggles the SaleLines relation, and pagination is driven by next_url. It does not disclose rate limits or default page size behavior beyond the schema, keeping it at 4.

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?

Dense and front-loaded: return fields first, then filtering, then pagination and endpoint, with no filler sentences. The leading field enumeration is slightly redundant given the absent output schema, but it earns its place by compensating for that gap.

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?

With 13 optional parameters, no output schema, and no destructive behavior, the description covers what matters: return shape, filterable dimensions, default date semantics, relation includes, and pagination. Missing only peripheral behavior such as rate limits or error conditions.

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 coverage is 100%, so the parameters are already documented with patterns, enums and defaults. The description adds only marginal value beyond the schema—reiterating the filter set, the completeTime default for date_field, and that include_lines means items sold—so the baseline 3 applies.

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?

States a specific verb+resource ('Sales history' listing) and enumerates exactly what is returned (saleID, completed/voided flags, completeTime, totals, customerID, employeeID, shopID, registerID). The plural 'list' plus the pagination hint distinguishes it cleanly from the sibling get_sale, which fetches a single record.

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 clear context for use: filter by date range on completeTime (default) or timeStamp, plus shop/customer/employee, and set include_lines only when line items are needed. It never explicitly contrasts itself with get_sale for single-record lookups or states exclusions, so it falls short of a 5.

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.