get_top_links

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

No annotations are provided, so the description carries the full burden. It discloses that the tool returns top links ranked by total clicks, and specifies the fields (short code, title, total clicks, unique clicks). It also states the default lookback of 30 days. This is adequate transparency for a read-only tool.

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 sentences long, front-loaded with the core purpose, and every sentence adds value. No filler or redundancy.

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 the tool has 2 optional parameters, 100% schema coverage, and no output schema, the description explains the return fields (short code, title, clicks) and default behaviors. It is sufficiently complete for an agent to understand what the tool does and what to expect.

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 100%, so the baseline is 3. The description mentions the defaults for 'days' (30) and 'limit' (10), but the schema already has these details ('Lookback window in days (default 30)', 'Max number of links to return (default 10)'). The description adds no meaningful extra meaning beyond what the schema provides.

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's purpose: 'Get the top performing links in the workspace ranked by total clicks.' It specifies the verb 'Get' and the resource 'top performing links', and distinguishes from sibling tools like 'get_link' (single link) and 'list_links' (all links) by focusing on the 'top performing' aspect.

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 mentions the default lookback period and indicates when to use the tool (to get top links). However, it does not explicitly state when not to use it or suggest alternatives like 'get_link_analytics' for deeper analytics. The context is clear but lacks exclusion guidance.

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