get_app_comparison

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

With no annotations, the description carries the full burden. It discloses the return format (JSON string) and the accepted period values, which is useful. However, it does not mention permissions, rate limits, side effects, or limitations. Since the operation is clearly read-only, the omission is a minor gap.

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 concise and well-structured: the purpose is stated in the first sentence, followed by the argument and return format. Every sentence provides value with no redundancy or excess length.

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?

The tool is simple (one optional parameter), and the description covers its purpose and parameter format. An output schema exists, so detailed return fields are predefined. Missing details like timezone handling or default behavior are minor given the straightforward scope.

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 only defines period as a string with a default, but the description enriches it with the exact allowed values ('7d', '30d', '90d', '1y', or a date range) and the return format. This fully compensates for the 0% schema description coverage.

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 'Compare metrics across all your Shopify apps side by side,' using a specific verb (compare) and resource (metrics across all apps). This distinguishes it from siblings like get_app_details (single app) and get_churn_analysis (churn-specific).

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 implies the use case—comparing metrics across all apps—but does not explicitly mention alternatives or when not to use this tool. There is no comparison to sibling tools or prerequisites, so guidance is implicit rather than explicit.

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