Search users

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

Annotations already declare readOnlyHint and openWorldHint. Description adds return fields (id, name, email, role, organization) but does not disclose rate limits, pagination, or other behaviors beyond the schema. Adds modest 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?

Two sentences; first states purpose and scope, second lists return fields. No superfluous content. Front-loaded and efficient.

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?

Covers purpose, return fields, and query scope. Lacks pagination details or sorting behavior, but given annotations and schema completeness, it is sufficient. No output schema makes the return field list helpful.

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. Description adds examples for query (email, phone) beyond schema's 'name', but does not add meaning for the limit parameter. Overall modest value added.

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?

Clearly states the verb 'Find users' and the resource 'users' with scope 'by a free-text query'. Distinguishes from siblings like zendesk_get_user (specific ID) and zendesk_search (general).

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?

Indicates when to use (free-text search for users) but does not explicitly mention when not to use or alternatives. However, the free-text specification and sibling context provide sufficient guidance.

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