Close Incident

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

With no annotations, the description carries full burden. It states 'Sets state to Closed' but lacks details on destructive nature, permissions, or whether resolution requires prerequisites. A minimal disclosure for a mutation operation.

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?

Single sentence with subject, verb, and key details. No redundant words; front-loaded purpose.

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 simple 3-param operation without output schema, the description is adequate but minimal. Given no annotations, more context on behavior (e.g., irreversible, required permissions) would improve completeness.

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 covers 67% of parameters (incidentNumber and closeCode have descriptions). The description merely restates parameter names without adding format, constraints, or default values. closeNotes lacks schema description and description adds no extra meaning.

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?

Clearly states verb and resource: 'Resolve and close an incident'. Distinguishes from siblings like 'update_incident' by specifying the end state 'Closed'.

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?

Implicitly indicates when to use (to close an incident) but no explicit guidance on when not to use or alternatives beyond the context. For example, it doesn't mention using 'update_incident' for non-closing changes.

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