get_top_bugs

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

With no annotations provided, the description carries full burden for behavioral disclosure. It mentions 'SQL widget' and 'templateId: 4' which gives some implementation context, but doesn't describe what the tool returns (format, structure), whether it's read-only or has side effects, authentication requirements, rate limits, or error behavior. The description is insufficient for a tool with 8 parameters.

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, efficient sentence that gets straight to the point. It uses emoji and parenthetical notes effectively without unnecessary verbosity. However, the 'SQL widget, templateId: 4' note feels somewhat cryptic and could be better integrated.

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 8 parameters, no annotations, and no output schema, the description is inadequate. It doesn't explain what the tool returns (critical since there's no output schema), doesn't provide usage context beyond a cryptic SQL widget reference, and offers minimal behavioral transparency. The description should do much more to compensate for the lack of structured metadata.

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 schema already documents all 8 parameters thoroughly. The description adds minimal value beyond the schema - it mentions 'optional issue links' which relates to the 'issueUrlPattern' parameter, and 'templateId: 4' which matches the default value in schema. This meets the baseline for high schema 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 the tool's purpose: retrieving 'Top N most frequent defects' with 'optional issue links'. It specifies the resource (defects/bugs) and action (get top N), but doesn't explicitly differentiate from sibling tools like 'get_bug_failure_info' or 'get_bug_review' that might handle bugs differently.

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. It mentions 'SQL widget, templateId: 4' which hints at a specific implementation context, but doesn't explain when this tool is appropriate compared to other bug-related tools in the sibling list or what prerequisites might exist.

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