preview_release

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

With no annotations, the description carries the burden of disclosing side effects. It explicitly states the tool does not write, which is a critical non-destructive behavior. However, it doesn't elaborate on validation, error conditions, or other runtime behavior beyond this main distinction.

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 a single, front-loaded sentence that conveys the essential action and its non-writing nature without any redundant information.

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 covers the core functional difference from create_release, but given the tool's only parameter is a complex nested array and the description offers no parameter context, there is a significant gap in completeness. The existence of an output schema helps, but the lack of input guidance makes this only minimally viable.

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?

The description does not mention the 'summary' parameter at all. The schema has a detailed Section structure, but with 0% description coverage, the tool description offers no guidance on how to construct the preview content, leaving the agent to infer from schema alone.

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 renders the release block ('Rendert den Release-Block') and explicitly contrasts with create_release by saying it does so without writing ('ohne zu schreiben'), making its purpose distinct from the sibling write operation.

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?

It provides a direct comparison to create_release, indicating this tool is the non-persistent preview variant. This gives clear context for when to use it (to preview) versus when to use create_release (to actually write), though it doesn't mention other alternatives like render_changelog.

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