bulk_update_preview

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

With no annotations provided, the description carries the full burden. It clearly labels the tool as a 'dry run' and 'preview,' implying no side effects. It also documents parameter constraints (max_results default/max). However, it does not explicitly state read-only behavior or authentication requirements.

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 concise and well-structured: a one-sentence purpose, a usage hint, and a clearly formatted parameter list. Every sentence adds value, and no extraneous text is present.

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?

Given the tool's simplicity and the existence of an output schema, the description covers the essential aspects: purpose, usage order, and parameters. It does not address error conditions or prerequisites, but for a preview tool, this is largely adequate.

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 description coverage is 0%, but the description lists all four parameters (query, command, max_results, instance) with brief meanings (e.g., 'YouTrack search query,' 'Max issues to preview (default: 50, max: 100)'). This adds significant context beyond the schema's property titles.

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 tool's purpose: 'Preview which issues would be affected by a bulk update (dry run).' It uses a specific verb ('preview') and resource ('issues affected by bulk update'), and the sibling tool 'bulk_update_execute' provides clear differentiation.

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 explicitly advises to 'Call before bulk_update_execute,' establishing a clear usage order. It also clarifies the dry-run nature, though it does not explicitly discuss when not to use this tool or alternatives.

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