update_ticket

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

With no annotations, the description must disclose behavioral details, but it only says 'update fields' without explaining null-value semantics, idempotency, behavior when a ticket doesn't exist, or response format. It leaves ambiguity about whether passing null clears a field or leaves it unchanged, which is critical for a mutation tool.

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 concise: one purpose sentence plus a clean one-line-per-parameter list. It is front-loaded with the action and avoids unnecessary words, making it easy for an agent to quickly parse.

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 update tool, the description covers purpose and parameter meanings, but it misses key operational context such as null semantics, minimum requirements, error behavior, and permissions. An output schema exists so return values are covered, but the lack of behavioral context and explicit usage guidance leaves gaps.

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 has zero description coverage, so the description fully compensates by explaining every parameter: ticket_id as unique numeric ID, subject as optional new subject, description as plain-text/HTML, and status with examples. This adds significant meaning beyond the raw schema.

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 uses a specific verb+resource: 'Update fields on an existing ticket in ServiceDesk Plus.' This clearly distinguishes from siblings like create_ticket (existing vs new) and list/get (fields vs retrieval). The Args section further reinforces the tool's purpose.

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 implies use on existing tickets, but it does not explicitly contrast with create_ticket or other alternatives, nor does it state when not to use it. There are no preconditions or exclusions described, so the guidance is implied rather than explicit.

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