Skip to main content
Glama

StudioVector: Chat with your Mindbody

Sales and revenue summary

sales_summary
Read-onlyIdempotent

Answers revenue and sales questions in one call. Reads every sale in a date range and returns a compact summary instead of raw sales: totals (sales, net sales, discounts, tax, amount collected, average sale, unique clients, contract and gift card sales, returns), sales by day, week or month, top items, and revenue by category, payment method and location, plus optional top clients and a comparison with the previous period. Filters by location name or ID, which get_sales itself cannot. Use this instead of get_sales for any "how much did we sell or make" question. netSales is after discounts and before tax; collected is payments received by any method (account and gift card payments included, see byPaymentMethod). Amounts are in the site's currency. Mindbody calls: 1 per 200 sales (up to 10000 sales per range), fetched in parallel and doubled by compareToPrevious, plus cached lookups for location and category names and 1 per 20 topClients (at most 104).

Input Schema

NameRequiredDescriptionDefault
topNoRows per ranked breakdown, 1-25 (default 10). The rest are folded into one "other" row.
rangeNoDate range ending today (default last_30_days). Use startDate/endDate for other ranges.
siteIdNoSite to call (SiteId header). Default -99.
endDateNoLast day, inclusive (default today). At most 366 days after startDate.
includeNoBreakdowns to return besides totals (default byPeriod, topItems, byCategory, byPaymentMethod, byLocation). Add "topClients" for the biggest spenders by name.
intervalNobyPeriod granularity. auto (default): day up to 31 days, week up to 120, else month.
locationsNoOnly sales at these locations: names or IDs, e.g. ["Clubville"] or ["1"].
startDateNoFirst day, e.g. 2026-09-01 (business-local). Default: 30 days ending endDate.
compareToPreviousNoAlso total the previous period and report the change in percent (doubles the sales calls). Whole calendar months compare with the previous whole months, month to date with the same days last month, other ranges with the same number of days just before.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive and open-world, so safety is covered. The description goes further with a real cost model: 1 call per 200 sales, cap of 10000 sales per range, parallel fetching, doubling by compareToPrevious, cached location/category lookups, and 1 call per 20 topClients (max 104). It also defines currency and the netSales/collected distinction, which are behavioral facts not present in annotations.

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?

Purpose and the get_sales routing rule are front-loaded, and the metric definitions and call-cost math are compressed into single clauses with no filler. It is a dense wall of text rather than structured into bullet-like segments, which slightly hurts scanability for a description this feature-rich, but no sentence is expendable.

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 and 9 parameters, the description carries the return-value burden and does so by enumerating every metric and breakdown section plus currency and netSales/collected definitions. The remaining gap is that it does not describe the response's overall shape (e.g. how totals nest relative to breakdown arrays) with no output schema to fall back on.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds interpretation the schema lacks: what compareToPrevious does to call volume and how it aligns periods, that locations accepts names or IDs where get_sales cannot, and what netSales versus collected actually mean. The only gap is that it doesn't tie the top-N folding or interval auto-selection back to parameters, though the schema already documents those.

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 ('answers revenue and sales questions', 'reads every sale in a date range') and enumerates exactly what comes back: totals, byPeriod, topItems, byCategory, byPaymentMethod, byLocation, optional topClients and comparison. It explicitly distinguishes itself from get_sales by returning 'a compact summary instead of raw sales' and by supporting location filters get_sales cannot.

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 an explicit routing rule: 'Use this instead of get_sales for any "how much did we sell or make" question', with the inverse implied (get_sales for raw line items). It also flags the capability gap (location name/ID filtering) that makes this the only option for that case, so the agent has both a positive and a negative selector.

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