eds_preview_page

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

With no annotations, the description must disclose behavioral traits. It indicates a write operation ('trigger preview') but does not mention side effects, prerequisites, rate limits, or return values. The description is minimal but not misleading.

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?

A single sentence conveys the purpose and effect. It is front-loaded with the action. However, it could be restructured to emphasize when to use it. Very concise but lacks some detail.

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 simple (one required parameter, no output schema). The description covers the core action adequately. Missing details like error handling or success confirmation, but it is minimally complete for a straightforward task.

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%, and the parameter 'path' is described in the schema (path relative to site root). The description repeats this link to the preview domain but adds no new semantics beyond the schema.

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 uses a specific verb ('Trigger preview') and resource ('EDS page'), and the domain pattern '*.aem.page' clarifies the scope. It distinguishes this tool from siblings like 'eds_bulk_preview' (multiple pages) and 'eds_preview_and_publish' (preview+ publish).

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 for triggering preview on a single page but does not explicitly state when to use this tool versus alternatives (e.g., bulk preview or preview-and-publish). No exclusions or conditions are mentioned.

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