autotask_create_ticket_note

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

No annotations are provided, so the description carries full burden. It does not disclose behavioral traits such as permission requirements, whether the operation is destructive, or what the response format is. The single sentence lacks essential behavioral context.

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, which is concise but at the expense of completeness. It does not front-load critical information such as required parameters or output. The brevity leaves the agent underinformed.

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 tool has 5 parameters (2 required), no output schema, and no annotations, the description fails to provide complete context. It does not mention what the tool returns, success/failure indicators, or any side effects. The description is insufficient for reliable invocation.

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% with descriptions for all 5 parameters. The tool description adds no extra meaning beyond the schema. For example, it does not explain the significance of noteType or publish levels, nor the relationship between ticketId and the ticket entity. Baseline 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 verb and resource. It differentiates from sibling tools like autotask_create_ticket (creates ticket) and autotask_get_ticket_note (retrieves notes), but does not explicitly distinguish from other note-creation tools like autotask_create_company_note. The name itself adds clarity.

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 guidance is provided on when to use this tool versus alternatives (e.g., autotask_create_ticket_charge, autotask_create_ticket_checklist_item). There is no mention of context, prerequisites, or when not to use it. With many sibling tools, this could lead to incorrect tool selection.

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