Skip to main content
Glama
Sign In

Nuira

by ai.nuira
OverviewDiscussionsAdmin

Shopify sales breakdown

get_sales_breakdown
Read-onlyIdempotent

Shopify's own Total sales breakdown for the current period: gross sales, discounts, returns, net sales, shipping and taxes — the same lines, with the same definitions, as the merchant's Shopify admin. Use this whenever the question is about revenue in the merchant's own terms, or when they say our number disagrees with Shopify. IMPORTANT: netSales is Shopify's revenue figure and EXCLUDES tax and shipping; orderTotal is the order-total basis the rest of Nuira still reports and INCLUDES both, which is why the two differ — say so rather than picking one silently. Returns count in the period the refund was issued, not the period of the order it reverses. When complete is false, some orders in the range predate these figures and every line understates: say that instead of quoting the totals as final. Optional from and to (inclusive YYYY-MM-DD, both or neither, never after today) read another span instead of the default period. A named month, a week or two dates the operator gave MUST be sent here: without them this reads the last 30 days, which is not that month.

Input Schema

NameRequiredDescriptionDefault
toNoLast day of the span, inclusive, as YYYY-MM-DD; not after today. Send together with `from`, or omit both to read the default 30-day period.
fromNoFirst day of the span, inclusive, as YYYY-MM-DD. Send together with `to`, or omit both to read the default 30-day period.
salesChannelNoOnly online orders (the web shop) or only point-of-sale orders; omit for every channel. When the operator says 'solo web', 'online only' or 'sin POS', send online — and keep sending it for the rest of the conversation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / salesChannel
      Added value: +{
+  "description": "Only online orders (the web shop) or only point-of-sale orders; omit for every channel. When the operator says 'solo web', 'online only' or 'sin POS', send online — and keep sending it for the rest of the conversation.",
+  "enum": [
+    "online",
+    "pos"
+  ],
+  "type": "string"
+}
  2. Changed2 schema fields changed
    • addedInput schema / properties / from / description
      Added value: +"First day of the span, inclusive, as YYYY-MM-DD. Send together with `to`, or omit both to read the default 30-day period."
    • addedInput schema / properties / to / description
      Added value: +"Last day of the span, inclusive, as YYYY-MM-DD; not after today. Send together with `from`, or omit both to read the default 30-day period."
  3. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Goes well beyond the readOnly/idempotent annotations: it explains the netSales vs orderTotal discrepancy, that returns count in the refund period rather than the order period, and that incomplete data understates every line. It does not mention caching, freshness, or latency, but for a read-only reporting tool the disclosed quirks are the ones an agent would otherwise get wrong.

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?

Front-loaded with the resource definition, then the usage trigger, then the semantic cautions, then parameters. Every sentence carries operational weight, though the IMPORTANT marker and the netSales/orderTotal sentence are dense enough to require a careful read; the paragraph is long for a single description.

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?

There is no output schema, and the description fills that void by enumerating the reported lines, defining the two competing revenue bases, explaining the `complete` flag, and stating the default period. An agent has everything needed to call the tool and to report its output honestly without further context.

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 already 100%, so the baseline is 3; the description still adds decision-relevant meaning — from/to are inclusive, must be sent together or not at all, must never be after today, and omitting them silently reads a 30-day window. The salesChannel semantics ('online only', 'solo web') live in the schema rather than the description, which is a minor gap.

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?

Names a specific verb+resource: Shopify's own Total sales breakdown (gross sales, discounts, returns, net sales, shipping, taxes) for the current period, using the merchant's Shopify definitions. It explicitly separates this from the rest of the product's reporting basis (`orderTotal`), which distinguishes it from siblings like get_sales or get_sales_by.

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 triggers: use when the question is about revenue in the merchant's own terms, or when the merchant says our number disagrees with Shopify. It also states a hard requirement — a named month, week, or two operator-supplied dates MUST be passed here because the default is last 30 days — and warns against quoting totals as final when `complete` is false.

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

All Nuira toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources