shopifyql_query

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

The description discloses the required 'read_analytics' scope, which is a useful behavioral trait since no annotations are provided. However, it does not state whether the query is read-only, how results are returned, or any error/rate-limit behavior, leaving much of the behavioral burden unaddressed.

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, compact sentence that conveys the core purpose and scope requirement without any wasted words.

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?

For a tool with one parameter and no output schema, the description is minimal but covers the basic purpose and scope. However, the existence of a sibling tool with the same name pattern (run_shopifyql_query) is not addressed, and the return value is not described, leaving the description incomplete for an agent navigating a large toolset.

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?

The input schema already provides full coverage for the single 'query' parameter, so the description adds no additional parameter semantics. It only contextualizes the query as being for analytics, which is a minor addition.

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 executes a ShopifyQL query for analytics and mentions the required scope. However, it fails to distinguish this tool from the sibling 'run_shopifyql_query', which appears to have the same purpose, so it does not fully differentiate.

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 is provided on when to use this tool versus alternatives like 'run_shopifyql_query' or 'get_analytics_report'. The only contextual information is the scope requirement, which is a prerequisite rather than a usage guideline.

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