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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint=false, so the safety profile is covered. The description adds genuine context beyond that: the data source (forum_posts), the recurrence threshold (3 distinct months over 18 months), and the ecosystem restriction. It stops short of covering return format details, but that is a minor gap given the annotations.

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?

Two tightly written sentences with the core purpose front-loaded, followed by the return semantics and scope. Slightly dense but every clause carries information; nothing is wasted.

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 read-only annotations covering safety and no output schema, the description does the needed work: it explains what is returned (top keywords/error codes from forum posts) and the recurrence/threshold logic. An agent can call this correctly; only minor gaps remain around exact output shape.

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 both parameters (min_months, window_months) are already documented in the schema, which is treated as the baseline 3. The description restates the default thresholds but adds no syntax or format meaning beyond what the schema conveys.

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?

States a specific verb ('Identify') and a precise resource ('error patterns that recur across multiple Canton SDK or Splice release windows'), and contrasts structural recurring bugs with one-off regressions. This is distinguishable from siblings like find_known_issues or diagnose_error without opening any schema.

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?

Gives clear usage context ('useful for triage prioritisation and for choosing what to add to a runbook') and an explicit scope constraint ('Canton/Daml/Splice ecosystem only'). It doesn't name alternatives or exclusion conditions versus the many sibling tools, so not a full 5.

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