Skip to main content
Glama

PHP Point of Sale MCP by usefulapi

List sales

phppos_list_sales
Read-only

List or search completed sales, by date range, customer (id or email) or location. verbosity: minimal (headline fields), medium (adds customer, totals, profit, location - the default here) or full (every line item, payment and tax). Suspended sales (layaways, estimates) are fetched with suspended_type. GET /sales.

Input Schema

NameRequiredDescriptionDefault
limitNoRows per page, 1-1000 (default 25).
offsetNoRows to skip (default 0). Pass the previous reply's next_offset (paging.next_offset for a report).
end_dateNoOnly sales on or before this date or date-time.
verbosityNominimal, medium (default) or full.
start_dateNoOnly sales on or after this date or date-time (yyyy-mm-dd or yyyy-mm-dd hh:mm:ss).
customer_idNoOnly this customer's sales.
location_idNoOnly sales at this location id - see phppos_list_locations.
email_addressNoLook the customer up by email address and return their sales.
suspended_typeNoFetch suspended sales instead of completed ones: a comma-separated list of layaway, estimate or a sale type name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds genuinely useful behavior: what each verbosity level returns (headline fields vs. line items/payments/tax) and that suspended_type switches the result set entirely. It stops short of describing pagination behavior or result ordering, which matters for a paged list endpoint.

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?

Three dense sentences, front-loaded with the resource and filters before the verbosity detail. The trailing 'GET /sales' is minor but informative for endpoint mapping; nothing else is filler.

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 9-parameter, all-optional list tool with no output schema and full schema coverage, the description supplies what structured fields cannot: payload-size tradeoffs between verbosity levels and the suspended-vs-completed distinction. Pagination semantics live in the schema, so nothing critical is missing.

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 parameter is already documented, making 3 the baseline. The description does add a little beyond the enum – it explains what minimal, medium and full actually contain – but it repeats the verbosity options and the customer-id-or-email idea rather than expanding on limit/offset or date formats.

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 (list/search) and resource (completed sales), then enumerates the three filter axes: date range, customer (id or email), location. It also carves out the suspended-sale case, so an agent can immediately tell this apart from phppos_get_sale (single record) and from the other list_* siblings.

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 routing context: use suspended_type for layaways/estimates rather than completed sales, and states that medium is the default verbosity. It does not explicitly name phppos_get_sale as the alternative for retrieving one sale, which is the only obvious inference left to the agent.

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.