preview_update_set

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint, so the description's 'Preview' aligns. However, description adds no extra behavioral context (e.g., what happens with an empty set, rate limits, or if preview consumes resources).

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, 7 words, no fluff. Front-loaded and clear, but could be slightly more structured (e.g., separate purpose and usage details). Still 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?

The description is minimal and lacks return value context (e.g., what the preview output is, whether it's a summary or detailed list). Given no output schema, description should hint at what to expect. Annotations partially compensate for safety.

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 covers both parameters (sys_id, limit) with descriptions. The tool description does not add any additional meaning or usage notes beyond the schema. Baseline 3 is appropriate given 100% coverage.

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 uses specific verb 'Preview' and resource 'changes contained in an Update Set', clearly distinguishing it from siblings like list_update_sets or get_update_set. It directly states what the tool does.

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 tool vs alternatives like list_update_sets or get_update_set. Does not specify when to use for dry-run or to avoid previewing large update sets.

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