autotask_create_ticket_note

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

No annotations are provided, so the description must cover behavioral aspects. It does not disclose any side effects, required permissions, or whether the note creation triggers notifications. The verb 'create' implies writing, but no further context is given.

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 short sentence that efficiently conveys the core purpose. It could benefit from a bit more detail, but it is not verbose.

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 5 parameters, no output schema, and no annotations, the description provides a minimal but adequate purpose. However, it omits details about return values, potential errors, and prerequisites (e.g., ticket must exist), which would help complete the context.

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 coverage is 100%, so the description adds limited value beyond field names and types. However, the description lists important optional parameters like noteType and publish, but does not explain their impact (e.g., visibility, type categorization). Baseline of 3 is appropriate.

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 'Create a new note for a ticket' clearly states the action (create) and the resource (ticket note), distinguishing it from other create tools like autotask_create_ticket or autotask_create_ticket_attachment. However, it could be more specific by mentioning the required and optional parameters.

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?

No explicit guidance on when to use this tool versus alternatives like autotask_search_ticket_notes or autotask_get_ticket_note. The context of needing a ticketId and description implies usage for adding a note to an existing ticket, but no exclusion criteria or alternatives are mentioned.

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