autotask_search_ticket_notes

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

No annotations provided, so description carries full burden. It does not disclose behavior beyond the verb 'search' – e.g., pagination behavior, sorting, or whether it returns full notes or summaries. The pageSize parameter hints at pagination but not detailed.

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?

Single sentence, concise and front-loaded. However, could be slightly more descriptive without bloating.

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 search tool with 2 parameters, no output schema, and no annotations, the description is too minimal. It does not explain the return format, ordering, or the difference from other note-related tools (get, create).

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 baseline is 3. The description adds no additional meaning to parameters beyond what's in the schema (ticketId is required, pageSize has defaults).

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 is clear: 'Search for notes on a specific ticket' – it specifies the action (search) and the resource (notes on a ticket). It distinguishes from siblings like autotask_get_ticket_note (which retrieves a single note) and autotask_create_ticket_note (which creates).

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 on when to use this vs alternatives like autotask_get_ticket_note or other search tools. No mention of context (e.g., ticket must exist) or exclusions.

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