update_finding

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

With no annotations provided, the description carries the full burden. It discloses rate limiting, write scope requirement, and a detailed state-transition gate that explains rejection and redirection behavior. This is thorough, though it could mention the exact error response format.

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 paragraphs, first immediately stating the update action and listing fields, second detailing the state gate. It is clear and without filler, though the second paragraph is fairly dense.

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 output schema exists, the description adequately covers the update behavior and the complex state-transition gate. It mentions the return format. One minor gap: no mention of error responses beyond redirection.

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 schema coverage is 0%, so the description must compensate. It lists all optional parameters and notes severity enum values (Critical/High/Medium/Low/Info) and that finding_id must be >0. However, for many self-explanatory fields, it adds minimal meaning beyond the parameter names.

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 'Update an existing finding' and lists the fields that can be updated. It also distinguishes from sibling tools like 'reopen_finding' by detailing when that alternative should be used, thanks to the state-transition gate explanation.

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 explicitly states requirements such as 'At least one field required' and 'Requires write scope. Rate-limited.' It also provides clear when-not guidance: state-transition gate conditions that redirect to 'reopen_finding', with role-based exceptions.

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