Skip to main content
Glama
Novigante

mcp-loyverse

by Novigante

sales_summary

Read-only

Retrieve sales metrics: revenue, receipt count, average ticket, discounts, taxes, and tips for presets or a custom date range. Filter by store to analyze performance.

Instructions

Get a sales summary for a given period: total revenue, receipt count, average ticket, discounts, taxes, and tips. Use presets (today, yesterday, this_week, this_month) or explicit date range.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
toNoEnd date (ISO 8601) for explicit date range
fromNoStart date (ISO 8601) for explicit date range
periodNoDate preset for the summary period
store_idNoFilter by store UUID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. Beyond that, the description discloses the aggregate fields returned, which is useful since there is no output schema, but it omits behavioral details such as whether period and from/to are mutually exclusive or which wins on conflict.

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?

Two tight sentences with the return payload front-loaded and the input mechanism second. No filler or redundancy.

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 no output schema, the description usefully enumerates the metrics returned, and the readOnly annotation covers safety. The remaining gap is the undocumented interaction between the period preset and the explicit from/to range, which an agent must guess at.

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 the schema already documents all four parameters, making 3 the baseline. The description only restates the preset-vs-date-range distinction and lists four of the six enum presets, adding little 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?

States a specific verb and resource ('Get a sales summary') and enumerates the exact metrics returned (revenue, receipt count, average ticket, discounts, taxes, tips), which distinguishes it from list-oriented siblings. It does not, however, explicitly contrast itself with related siblings like top_selling_items or list_receipts.

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

Usage Guidelines3/5

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

The sentence 'Use presets ... or explicit date range' gives parameter-usage direction, implicitly signaling this tool is for aggregate reporting over a period. There is no explicit when-to-use vs alternatives guidance and no mention of precedence when both period and from/to are supplied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.