List Zendesk Macros

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

Annotations already declare readOnlyHint and idempotentHint. The description adds value by specifying offset pagination details, per-user OAuth scope, and that no shared admin key is needed. It also describes the returned structure (id, title, etc.), providing context beyond annotations.

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 informative with 4-5 sentences, front-loaded with the main purpose. Each sentence adds value (purpose, definition, return fields, usage hint). Could be slightly more concise, but structure is clear.

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?

Despite no output schema, the description fully explains return fields and pagination. Parameters are covered by schema. The tool is used to list macros, with clear context for follow-up (preview_macro_diff). Complete for a list operation.

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?

With 100% schema coverage, both parameters (page, per_page) are well-described in the schema with defaults and constraints. The description mentions offset pagination but does not add significant new meaning beyond the schema. 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 clearly states it 'List the active macros available to the authenticated user' and specifies the returned fields (id, title, description, scope, actions) with offset pagination. This specific verb-resource combination distinguishes it from siblings like preview_macro_diff.

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?

The description implies usage context: to list macros as a precursor to preview_macro_diff by stating 'Pass a macro id from here to preview_macro_diff'. It also notes OAuth scoping. However, no explicit when-not-to-use or alternative tools are mentioned, though siblings provide coverage.

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