Create Release

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

Annotations (all false) indicate the tool is not read-only, not idempotent, not destructive, and not open-world. The description aligns by stating it 'Create a release', implying a side effect. It adds behavioral details about return fields and draft behavior, but does not discuss permissions, rate limits, or potential failures. The description carries some burden but is not exhaustive.

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 efficient sentences. The first sentence front-loads the primary purpose and output fields. The second sentence provides essential parameter guidance. No extraneous 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?

Given no output schema, the description explicitly lists the return fields. It covers all parameter semantics and default behavior. However, it omits potential error scenarios (e.g., duplicate version) and lifecycle interactions (e.g., effect on related entities). Still, for a create tool, it is adequately complete.

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%, but the description adds meaning beyond property descriptions: it clarifies the default for 'product_id' and the semantics of omitting 'released_at' for drafts. This compensates for the schema's lack of such context.

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's purpose: 'Create a release and return it (id, version, changelog, released_at).' It uses a specific verb ('Create') and resource ('release'), and distinguishes from siblings like 'update_release' by being the creation counterpart.

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 provides context on when to omit 'released_at' for drafts and notes that 'product_id' defaults to the primary product. It also specifies that only 'version' is required. However, it does not explicitly advise when to use this tool over alternatives like 'update_release' or 'list_releases', which would strengthen this dimension.

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