Get sales summary
get_sales_summarySales summary for a period: sales, refunds, discounts, taxes and payments by type.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day. Default: same as from. | |
| from | Yes | First day. |
get_sales_summarySales summary for a period: sales, refunds, discounts, taxes and payments by type.
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day. Default: same as from. | |
| from | Yes | First day. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint=false and destructiveHint=false, so the safety profile is covered. The description adds useful content context by listing the included metrics, but does not explain aggregation granularity, authorization needs, or response behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single front-loaded sentence with zero wasted words. It immediately states the resource and the included metrics.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-only tool with full schema coverage and rich annotations, the description lists the summary contents, which is helpful because there is no output schema. It still lacks aggregation granularity and timezone details, but is largely complete for invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema already documents 'from' as first day and 'to' as last day with default same as 'from'. The description only says 'for a period' and adds no date syntax, default behavior, or other meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb/resource: a sales summary for a period, including sales, refunds, discounts, taxes and payments by type. It is clearly distinguishable from list_sales by being a summary rather than a transaction list, although it does not explicitly name the sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'for a period' implies use for period-based reporting, but there is no explicit when-to-use guidance, no exclusions, and no named alternative such as list_sales. The agent must infer that this is the aggregate/summary option.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.