get_top_pages_tool

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

With no annotations provided, the description carries the full transparency burden. It discloses the mutual exclusivity constraint ('not both') but does not explain what happens if neither zone_id nor zone_name is provided, or if both are provided. It also omits authentication/rate-limit details, though the tool is a simple read-only analytics call.

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 two short sentences with no wasted words. The first sentence states the core purpose, and the second states the key constraint. It is front-loaded and highly scannable.

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 has 5 optional parameters and an output schema, but the description does not clarify the expected behavior when neither zone_id nor zone_name is supplied (schema defaults to null). This ambiguity is a notable gap, though the output schema likely covers return structure. The description is adequate but not fully complete.

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 coverage is 100%, so all parameters are individually documented. The description adds relational meaning beyond the schema by stating 'Provide either zone_id or zone_name, not both,' which is not captured in the parameter descriptions. This additional semantic linkage raises the score above the baseline.

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 uses a specific verb and resource: 'Get top pages by request count.' This clearly distinguishes the tool from sibling analytics tools like get_zone_analytics_tool or get_traffic_by_country_tool, which target different metrics.

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 instruction 'Provide either zone_id or zone_name, not both' gives clear usage constraints for parameters, but it does not explicitly state when to choose this tool over alternatives. The context for selecting this tool versus siblings is only implied by its purpose.

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