refresh_instance

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

Beyond idempotentHint annotation, description reveals that omitting 'kinds' drops the HTTP client, enabling config file changes. Also notes idempotency and no destruction.

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?

Three sentences front-load purpose, then detail scope and alternatives. Every sentence adds value with no repetition or fluff.

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 cache invalidation tool with two optional parameters and no output schema, the description covers behavior, side effects, and alternatives completely.

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 basic descriptions, but the description adds contextual examples and explanation of default behavior (omitting kinds wipes all, instance defaults to sticky).

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 the verb 'Invalidate' and the resource 'in-memory cache for an instance', with scoping via 'kinds'. It is distinct from sibling tools which are get/list/audit operations.

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?

Explicitly says to call after user changes in Zendesk admin UI, and contrasts with one-off 'refresh: true' on other tools. Provides clear when-to-use and alternative.

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