shopify_sales_overview

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

No annotations provided, so the description carries full burden. It only states the tool returns 'Sales KPIs' without disclosing whether it's read-only, any authentication needs, rate limits, or data freshness. Insufficient for a tool with 5 parameters.

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 concise sentence that front-loads the core purpose. However, it is slightly too brief given the tool's complexity, missing opportunities to add value without significant bloat.

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?

Without an output schema, the description should explain what KPIs are returned (e.g., total sales, order count, AOV). It does not. With 5 parameters and 0% schema description coverage, key contextual information is missing, making it difficult for an AI agent to invoke correctly.

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 0%, meaning parameters like 'query' and 'limit' are not explained in the description or schema. The tool description adds no meaning beyond the schema field names and types, leaving agents uncertain about how to use 'query' (e.g., filter syntax) or the exact meaning of 'comparePreviousPeriod'.

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 clearly states the tool retrieves 'Sales KPIs for a date range' with optional period comparison, distinguishing it from sibling tools like shopify_sales_timeseries which focus on trends.

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?

No guidance on when to use this tool versus other sales analysis tools (e.g., shopify_sales_timeseries, shopify_sales_by_source). The only hint is the comparePreviousPeriod option, but no explicit when/when-not advice.

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