balena_set_release_note

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

Annotations indicate readOnlyHint=false, destructiveHint=false, and idempotentHint=false, so the tool mutates state but is not destructive. The description doesn't add details like whether the note overwrites existing notes, or any side effects. It doesn't contradict annotations, but it adds minimal behavioral context beyond them.

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 short sentence with no wasted words. It is front-loaded and easy to parse. It could be slightly more informative, but for its brevity it earns a high score on conciseness.

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 the tool is a mutation (not read-only) and lacks an output schema or rich annotations, the description is inadequate. An agent needs to know what the note update accomplishes, any constraints (e.g., max length), and whether it's idempotent (annotations say false). The description doesn't fill these gaps, leaving the agent under-informed.

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 0% description coverage, so the description must clarify parameter meaning. It only mentions 'note' generically, but doesn't explain that note is the text to set with a max length of 2000, or what release_id refers to precisely (e.g., the release's unique identifier). The parameter names are somewhat self-explanatory, but the description offers no additional semantic guidance.

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 'Set the note on a release' clearly states the verb (set) and the resource (release note), and combined with the tool name it is unambiguous. It doesn't explicitly distinguish from sibling tools, but the action is specific enough that an agent can infer it operates on a release's note, differing from other set/update tools.

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 guidance is provided on when to use this tool versus alternatives like balena_set_fleet_release or balena_pin_device_release. The description gives no context on typical usage scenarios, prerequisites (e.g., having the release ID), or exclusions. An agent would have to rely on the schema and name to infer usage.

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