shopify_top_products

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

No annotations are provided, so the description is the sole source for behavioral disclosure. It does not mention whether the operation is read-only, whether results are paginated, or how missing data is handled. The description only restates the tool's obvious purpose.

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 sentence, which is concise, but it lacks structure. It does not front-load key information like required parameters or usage context. It could be improved with bullet points or clearer phrasing.

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?

Given 6 parameters, no output schema, and many siblings, the description is insufficient. It does not specify the return format, how grouping by product vs variant affects results, or how the 'query' parameter works. The agent is left with many unknowns.

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%, so the description must compensate. But it adds no explanation for any parameter: 'query' (free text search?), 'limit' (maximum results?), 'sortBy' (enum values are listed but not defined). The agent must infer meaning from names alone.

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 it returns top products or variants sorted by net sales, gross sales, units sold, or orders. This is a specific verb+resource combination. However, it lacks explicit distinction from sibling tools like shopify_sales_by_customer_product or shopify_sales_overview, so it's not a perfect 5.

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?

The description provides no guidance on when to use this tool versus alternatives. With many sibling analytics tools, the agent gets no help selecting the appropriate one. No when-not or prerequisite info is given.

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