Skip to main content
Glama

Get Total Sales by Platform

get_total_sales_by_platform
Read-only

Returns the company's total sales in a date range, broken down by store platform. start and end are full ISO 8601 timestamps such as 2026-04-01T00:00:00Z; omit both for the last 90 days. Call get_ecommerce_connection_status first and answer together with it: never report zero for a platform whose data is still syncing or not connected. It reads the active company; for another company the user owns, pass its companyId from list_companies instead of switching the active company.

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_total_sales_by_platform"
  }
}

Input Schema

NameRequiredDescriptionDefault
endNoOPTIONAL end as a FULL ISO 8601 timestamp WITH time + timezone, e.g. '2026-04-30T23:59:59Z'. Never date-only. Omit alongside `start` to fall back to the rolling 90-day window.
startNoOPTIONAL start as a FULL ISO 8601 timestamp WITH time + timezone, e.g. '2026-04-01T00:00:00Z'. Always include the time component and Z suffix — date-only strings (like '2026-04-01') are rejected by the upstream service. If the customer doesn't specify a date range, OMIT this and the tool defaults to the last 90 days.
contextNoOptional, for analytics only. In one sentence, why you are calling this tool and how it serves the user's goal. Describe the purpose in general terms: never include names, emails, phone numbers, addresses, IDs or any other personal details.
companyIdNoOPTIONAL. The doolaCompanyId (an id like '30E5c1AQA326uOuDlsic4No7zZ5'). LEAVE THIS EMPTY/UNSET to use the customer's currently active company — that is the correct default for almost every question. Pass a value ONLY when the customer explicitly references a *different* company they own (e.g. 'show me transactions for my other company X'). NEVER pass a company name, slug, or human label here — only an exact id string.
llm_modelNoOptional, for analytics only. Your exact model identifier from your system prompt (e.g. "claude-opus-4-8"), or "unknown" if unsure. Never guess.
conversation_idNoOptional, for analytics only. The exact conversation_id from this server's previous response, unchanged. The first response provides one, so leave this out until you have it and never invent one. Keep passing the same value for the rest of the conversation, even when the user moves on to a new request.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior5/5

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

Beyond readOnlyHint/destructiveHint/openWorldHint, the description discloses the critical data-completeness caveat about platforms still syncing or not connected, the implicit 90-day default window, and the fact that it reads the active company by default. These are non-obvious behavioral traits that materially change how the agent interprets and reports results.

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?

Four tight sentences with the core purpose front-loaded, followed by date format, prerequisite tool, and company scoping in priority order. No filler and nothing repeated unnecessarily.

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?

No output schema exists, yet the description explains date semantics, the prerequisite data-freshness check, and company targeting, which covers what an agent needs to call it correctly. It stops short of describing the shape of the breakdown (per-platform totals/amounts), a minor gap given there is no output schema.

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 every parameter is already fully documented, and the description largely restates the ISO 8601 requirement and the omit-both default rather than adding new meaning. The only genuine addition is the pointer to list_companies as the source of companyId, which is marginal added semantics.

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 pair ('Returns the company's total sales') plus the breakdown dimension ('by store platform') and the temporal scope. It does not explicitly distinguish itself from the similar-sounding sibling get_sales_platforms, but the 'total sales broken down by' framing is concrete enough for an agent to select it correctly.

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 sequencing guidance ('Call get_ecommerce_connection_status first and answer together with it'), an explicit prohibition ('never report zero for a platform whose data is still syncing or not connected'), a default condition ('omit both for the last 90 days'), and routes cross-company queries to list_companies instead of switching the active company. When-to-use, when-not, and alternatives are all covered.

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.