Update Release

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

Beyond the annotations (idempotent true, destructive false), the description reveals that omitted fields stay unchanged, the tool returns the updated release, and released_at can be set to null to move back to draft. These are meaningful behavioral traits not covered by the annotations or schema.

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 three tight, information-dense sentences with zero filler. Every sentence contributes something essential: action, special behavior, and id resolution.

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?

For a tool with 4 parameters and no output schema, the description covers all key aspects: what it does, return value, partial update semantics, id source, and the special released_at behavior. Combined with the schema, it is fully complete for the tool's complexity.

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 has 100% coverage with each parameter already documented, but the description enriches the semantics for released_at (ship/draft) and explains the 'omitted fields unchanged' rule that applies to all parameters. This added value goes 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 clearly states the action ('Update a release') and the resource, with a specific verb and object. It also distinguishes from sibling tools like create_release by focusing on update and even implies the partial-update semantics ('omitted fields unchanged').

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 concrete usage guidance: resolve the id via list_releases, only id is required, and how to use released_at for shipping/draft. It doesn't explicitly call out alternatives or when not to use it, but the context is clear and actionable.

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