top_hotspots

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

No annotations are provided, and the description does not disclose any behavioral traits such as whether the tool is read-only, destructive, or requires authentication. For a query tool, it is expected to be read-only, but this is not stated, and no further behavioral context is given.

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 extremely concise at one sentence. While it could benefit from more detail, it does not include fluff. However, it may be too minimal to be fully effective; a slightly longer description would improve usability without losing conciseness.

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?

With an output schema present, the description does not need to explain return values. However, it lacks context about what constitutes a 'hotspot' or how the preset query works. The description is complete enough for a simple tool but could be more informative given the complexity of the domain.

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 fully describes both parameters (project_name and limit) with clear descriptions and default values. The description adds no additional meaning beyond the schema, so the baseline of 3 is appropriate given the 100% 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 'Preset query: top failure hotspots for a project' clearly states the tool's action (query) and resource (top failure hotspots for a project). It is specific enough to convey the basic purpose, though it does not differentiate from the sibling tool 'get_failure_hotspots' which likely has a similar function.

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 given on when to use this tool versus its alternatives (e.g., 'get_failure_hotspots'). The description lacks any context about usage scenarios, prerequisites, or exclusions, leaving the agent to infer usage from the name alone.

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