eds_bulk_preview

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

No annotations are provided, so the description carries the burden. It discloses the async nature, immediate job handle return, and the need to poll, which is the core behavioral trait. However, it does not mention any side effects, permissions, or whether the preview is read-only, leaving some ambiguity.

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 two sentences, front-loaded with the primary action, and includes only essential information: the job nature, return handle, polling instruction, and typical use cases. No wasted words.

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 tool is straightforward for an async batch operation, and the description explains the job flow and gives a polling reference. It does not describe output format, but since no output schema exists and the return is just a job handle, the description covers what an agent needs to know to proceed.

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?

All parameters are fully described in the input schema (100% coverage), so the description adds little beyond what is already structured. It reinforces the batch context but does not clarify parameter formats, making the schema's descriptions sufficient.

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 starts an asynchronous bulk preview job over many pages, which is distinct from the sibling tools eds_preview_page (single) and eds_bulk_publish (publishing). It also mentions returning a job handle and polling for progress, adding specific operational detail.

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 gives clear use cases ('section updates or content migrations') and implies the async job flow (poll ed_get_job_status), but it does not explicitly state when NOT to use this tool versus eds_preview_page or eds_bulk_publish.

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