linear_createReleaseNote

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

No annotations are provided, so the description must disclose behavioral traits. It only describes parameter choices, not idempotency, side effects, or error conditions. The agent lacks info on what happens on conflict or auth needs.

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 concise sentence with the verb upfront. Every word adds value, no redundancy.

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 creation tool with 5 params and no output schema, the description is adequate but missing details like return value, prerequisites (pipeline existence), and error handling. Could be more 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% with descriptions for each param. The tool description adds value by explaining the interplay between releaseIds and the range parameters, clarifying that either explicit IDs or a range can be used.

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 'Create a release note' (specific verb+resource) and specifies two methods (explicit IDs or range). It distinguishes from siblings like linear_createRelease (creates release, not note) and linear_updateReleaseNote (updates).

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 explains the two parameter modes (explicit IDs or range) and implies the pipeline context. However, it does not explicitly state when not to use this tool or mention alternatives like linear_updateReleaseNote.

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