flash_stm32

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

No annotations exist, so the description carries the full burden, and it does disclose meaningful behavior: the backing tool (st-flash), a side effect (the target is reset afterward), and a safety gate (confirm=true, which the schema only defaults to false). It stops short of describing failure modes, whether the flash erases the chip, or permission requirements.

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?

Two sentences, zero filler, front-loaded with the action and followed by the two most operationally important facts (side effect and required flag).

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?

An output schema exists, so return values need not be explained. For a destructive write operation with no annotations, the description covers the command, one side effect, and the confirmation requirement, but leaves the address parameter and error/recovery behavior undocumented.

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 description coverage is 0%, so the description must compensate, and it only partially does: it implies firmware_path is a .bin and confirms the confirm=true value. The address parameter (default 0x08000000) and its format or purpose are never explained.

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?

States a specific verb and resource (flash a .bin to an STM32 over ST-Link) and names the underlying command (st-flash). An agent can distinguish this from flash_esp32 and reset_stm32 from the description alone.

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?

Usage context is implied by the description, and it states the confirm=true prerequisite. It never says when to prefer this over flash_esp32, nor does it mention prerequisites such as a probed/connected ST-Link via probe_stlink.

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