balena_set_fleet_release

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the mutation nature is known. The description adds the specific behavioral detail that it changes the target for all unpinned devices (sparing already-pinned ones) and emphasizes the need for confirmation via the confirm parameter. This goes beyond the annotations by explaining the exact impact on devices, though it does not mention irreversibility or other side effects beyond what destructiveHint already implies.

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 tight two sentences. The first sentence front-loads the core action, and the second adds a necessary caution. No filler or redundancy exists; every word earns its place.

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 destructive operation with three required parameters and no output schema, the description effectively communicates the scope (fleet-wide, unpinned devices only), the need for confirmation, and the effect. It does not explain what happens to already-pinned devices (presumably they remain pinned) or mention validation of release/fleet existence, but these are minor given the annotations already flag destructive behavior and the description clearly states the core behavior. Overall, an agent can safely invoke this tool.

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 only 33% (only confirm has a description). The description compensates partially by clarifying confirm as a safety check ('confirm the fleet and release first'), which aligns with the schema's const=true constraint. However, fleet_id and release_id are left without added meaning; they are self-explanatory from context, but the description does not elaborate on their formats or relationships. Given the low schema coverage, the description adds some value but does not fully compensate for the two undocumented IDs.

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 opens with a specific verb+resource+target: "Pin an entire fleet to a release." This clearly differentiates it from the sibling balena_pin_device_release (which pins a single device) and from the many list/get/query tools. The intent 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?

The description provides clear context by stating the scope ("all unpinned devices") and a warning to confirm the fleet and release first. It does not explicitly name balena_pin_device_release as the alternative for single-device pinning, but the scope statement implicitly signals when this tool applies. No explicit when-not-to-use is given, so a 4 is appropriate.

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