Sync ITSM Ticket Status

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

Annotations already indicate destructiveHint=true and readOnlyHint=false. The description adds valuable context by stating that an admin operator + ticketing:write scope is required and that auth and endpoint are resolved from the stored connection only. This complements the annotations without contradiction, though it does not detail side effects.

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 concise sentences, front-loaded with the main action and followed by necessary prerequisites. No filler or redundancy.

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?

The tool has an output schema, and the description covers the core action and prerequisites. It does not fully explain the refresh behavior or side effects, but the annotations, schema, and output schema fill in the remaining details. Given the tool's simplicity, this is reasonably complete.

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 description coverage is 100% for all 5 parameters, so the schema already provides clear semantics (e.g., ticket_id described as the link id from create_ticket). The description adds no per-parameter details, but the baseline of 3 applies because the schema does the heavy lifting.

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 the specific action: 'Refresh a filed ticket's status from its ITSM through the connection.' This is a specific verb (refresh) + resource (ticket status) and distinguishes the tool from siblings like create_ticket, which creates a ticket rather than updating its status.

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 provides clear context for when to use the tool: it requires an admin operator and ticketing:write scope, and it resolves auth/endpoint from the stored connection only. However, it does not explicitly mention alternatives or when not to use the tool, so it lacks exclusions but still gives useful prerequisites.

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