autotask_update_ticket

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

With no annotations, the description must disclose behavioral traits. It indicates mutation ('Update') and partial update ('Only provided fields are changed'), but does not state permissions needed, rate limits, side effects, or what happens with omitted fields (they are unchanged). Lacks depth for safe invocation.

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 a single sentence with two clauses, immediately front-loading the purpose ('Update ticket record') and then adding the partial-update behavior. Every word is earned, no 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?

Given 9 parameters with a cross-dependency (assignedResourceID requires assignedResourceRoleID), no output schema, and no mention of return value or error handling, the description is incomplete. An AI agent needs more context about required dependencies and response format.

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 78%, so the schema already explains most parameters well. The description adds only a general behavioral note ('Only provided fields are changed') which applies to all params. No additional meaning beyond schema is provided, meeting the baseline for high coverage.

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 states 'Update ticket record', clearly specifying the verb (update) and resource (ticket). It also adds that only provided fields are changed, which distinguishes partial updates from full replacements. This is specific and distinguishes from create or search tools.

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 when to use (when updating a ticket) but does not provide guidance on when not to use or alternatives. It does not mention prerequisites like ticket existence or differentiate from sibling update tools (e.g., autotask_update_company).

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