Search Zendesk Tickets

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

Annotations declare readOnlyTrue and idempotentHint. Description adds important behavioral details: returns SLA state per ticket, total count, automatic addition of 'type:ticket' scope, and explains why 'type:' filter is not allowed. These go beyond what annotations convey.

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?

Description is two sentences plus an example line. Every sentence adds value: first sentence states purpose and key feature, second gives examples, third explains total count benefit. No wasted words.

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?

With 3 parameters fully described, no output schema, the description covers the return behavior (ticket data, SLA state, total count). It could mention relationship to get_ticket or list_tickets, but is still sufficiently complete for an agent to understand the tool's functionality.

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 parameter descriptions. Description adds value by providing example queries, explaining the automatic 'type:ticket' addition, and clarifying pagination behavior. This helps the agent understand parameter usage beyond schema alone.

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?

Description states it searches tickets using Zendesk query syntax, distinguishes from list_tickets (which likely returns all tickets) and get_ticket (single ticket). Mentions returning SLA state and total count, which adds specificity.

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?

Provides examples of queries and explains benefit for queue triage. Does not explicitly contrast with sibling search tools, but context is clear enough for an agent to decide when to use this tool.

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