Skip to main content
Glama

Sales summary

get_sales_summary
Read-onlyIdempotent

Takings, number of orders, average order, tips, refunds and cancellations for a period, compared with the same length of time before. Broken down by channel (QR at the table, till, online, delivery apps), by menu category and, for more than one day, by day. Use for 'how did we do today/this week', 'compare with last week'.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_sales_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoLast day, YYYY-MM-DD, included. Overrides period.
cafeNoWhich café, by name or slug. Only needed when the person has more than one (see list_my_cafes).
fromNoFirst day, YYYY-MM-DD. Overrides period.
branchNoOne branch (location) by name or id. Leave out for the whole business.
periodNoA named period on the café's clock. Weeks start Monday.
compareNoInclude the period before for comparison. Default true.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

The annotations already establish that this is a safe, read-only, idempotent operation. The description adds useful behavioral context about comparison against the same length of preceding period and about day-level breakdowns when the range exceeds one day.

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?

The definition is dense but front-loaded: metrics first, breakdowns second, and usage examples last. Every sentence contributes to selecting or interpreting the tool.

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?

For a six-parameter read-only reporting tool with no output schema, the description supplies the missing return-content context by listing the metrics and breakdown dimensions. Combined with complete schema descriptions and safe-operation annotations, nothing essential 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 coverage is 100%, so the parameters and their override/default rules are already well documented. The description reinforces the comparison concept but does not add syntax or selection guidance beyond the schema.

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?

The description names specific metrics (takings, orders, average order, tips, refunds, cancellations), the comparison period, and the breakdown dimensions. It is clearly a sales-summary tool, though it does not explicitly distinguish itself from siblings such as get_top_items or get_busy_times.

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?

It gives concrete usage examples like 'how did we do today/this week' and 'compare with last week', making the intended context clear. It does not state when not to use it or name alternative tools for overlapping questions.

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.

Resources