swsd_update_incident_state

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

Annotations already indicate mutation and non-idempotence. Description adds that it does not retry on transient failure and that state names are tenant-specific. Offers context beyond structured fields.

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?

Every sentence adds value: purpose, safety comparison, state examples, usage tip, failure behavior. No fluff, well front-loaded.

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 specific function and sibling tools, the description is nearly complete. Covers prerequisites, failure behavior, and tenant-specific states. Could mention reversibility but not critical.

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 both parameters, but description enriches: explains id auto-detection between internal and human-facing numbers, lists common state values, and advises checking current state.

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 the action: transitions an SWSD incident to a new state, with examples. Distinguishes from sibling swsd_update_incident as a safer wrapper, narrowing agent decision surface.

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?

Provides explicit guidance to call swsd_get_incident first to see the current state. Notes it's a WRITE operation and does not retry on failure. Could be more explicit about when to prefer this over swsd_assign_incident, but sufficient.

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