create_release

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

The description discloses that the tool bundles unreleased entries and renders two files, and it adds a specific behavioral rule about summary being allowed to be empty for purely private releases. However, it does not mention state changes, prerequisites, or potential side effects beyond rendering. With no annotations present, the description carries full burden and is only partially transparent.

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 long, with the first providing the primary action and the second detailing a parameter rule. It is front-loaded and contains no filler.

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 main function and an important parameter nuance, but it lacks guidance on when to use the tool and doesn't clarify what 'both files' refers to. Given the output schema exists, return type is likely covered, so overall completeness is moderate.

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 schema only defines summary as a nullable array of Section objects with a default, while the description explains that summary describes only the public block and may be empty for private-only releases. This adds meaningful semantic context beyond the type definition, though it does not cover all aspects of the Section structure.

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 that the tool bundles unpublished entries into a release and renders two files, using a specific verb and resource. It differentiates from siblings like preview_release or get_release by indicating an actual creation/rendering action. The meaning of 'both files' is not expanded, but the core purpose is unambiguous.

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 explicit guidance is given on when to use this tool versus alternatives such as preview_release or render_changelog. The only usage-related note is about summary behavior for private releases, which concerns parameter handling rather than tool selection. Thus, the description lacks context for an agent to choose this tool appropriately.

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