Skip to main content
Glama

Final POS – Custom POS Builder

Sales breakdown

hub_get_sales_breakdown
Read-only

Order-by-order breakdown for a date range — the same rows as Reports → Sales Breakdown. One row per order AND per refund. Answers 'show me the orders from Saturday', 'which order had that big discount', 'how many refunds last month', 'sales per day'. The totals and dailyTrend in the reply cover the WHOLE date range, not just the returned page — quote them directly instead of adding up rows. For headline figures alone use get_financial_summary; this tool is for when the merchant wants to see the actual orders.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, default 1
endDateYesEnd of the window, ISO 8601. Inclusive of the day when a bare date is given
outletsNoOutlet ids to restrict to. Omit for all outlets
pageSizeNoRows per page, default 50
stationsNoStation ids to restrict to. Omit for all stations
timezoneNoIANA timezone for the daily grouping, e.g. "America/Toronto". Defaults to the server timezone
startDateYesStart of the window, ISO 8601, e.g. "2026-08-01" or "2026-08-01T00:00:00Z"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, non-destructive, closed-world), and the description goes well beyond them by disclosing a non-obvious behavioral trap: `totals` and `dailyTrend` cover the WHOLE date range rather than the returned page, so the agent must quote them rather than sum rows. That is exactly the kind of guidance annotations cannot express.

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?

Front-loaded with the core identity in the first clause, then intent examples, then the pagination/totals caveat, then the sibling routing rule. Every sentence carries a distinct, actionable payload with no filler.

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

Completeness5/5

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

With no output schema, the description compensates by naming the reply's key fields (`totals`, `dailyTrend`) and explaining their scope, plus the row-per-order/refund shape. For a paginated reporting tool this is complete enough for an agent to call it and interpret the result correctly.

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 all seven parameters (page, pageSize, outlets, stations, timezone, start/end) are already documented in the schema with defaults and formats. The description adds no parameter-level syntax or constraints beyond that, so the baseline 3 is appropriate.

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 and resource ('order-by-order breakdown for a date range') plus the exact row granularity ('one row per order AND per refund'), which is the key distinguishing detail versus aggregate siblings. It also anchors the tool to a known UI surface (Reports → Sales Breakdown), so an agent can map user intent directly.

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

Usage Guidelines5/5

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

Gives explicit user-intent examples ('show me the orders from Saturday', 'how many refunds last month') and names the alternative with the condition that selects it: 'For headline figures alone use get_financial_summary; this tool is for when the merchant wants to see the actual orders.' When-to-use and when-not are both present.

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.