stm32_flash

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

No annotations are provided, so the description carries the full burden. It does disclose a safety behavior: 'Default is refuse' and confirm must be true, and it exposes a reset flag (-rst). However, it does not mention that flashing overwrites target memory or other potentially destructive side effects, which is a notable gap for a hardware-programming tool.

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 extremely compact, conveying the operation and a key safety requirement in two short sentences. However, the command-line snippet is not front-loaded with a plain-language purpose statement, making it less accessible. Still, there is no wasted content.

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's destructive potential and the presence of many sibling tools, the description is incomplete. It omits prerequisites, side effects, when to invoke it in the workflow, and what happens on success or failure. The confirmation gate is helpful but does not compensate for the missing context around a hardware write operation.

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 input schema covers 100% of parameters with descriptions and defaults, so the baseline is 3. The description adds minimal semantic value: it maps port/elf/reset to command-line flags but does not explain parameters beyond what the schema already states. No extra meaning is provided for 'confirm' beyond repeating its importance.

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 gives a command-line invocation ('STM32_Programmer_CLI -c port=SWD -w <elf> -rst') which implies writing an ELF to a target, but it does not explicitly state 'flash' or 'program' in natural language. It is specific to STM32 but may be opaque to an agent unfamiliar with STM32_Programmer_CLI flags, so it is more vague than clear.

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 mentions 'Requires confirm: true' as a necessary condition, but gives no guidance on when to use this tool versus siblings like stm32_build or stm32_generate_code. There is no mention of prerequisites (e.g., a built ELF) or use cases where flashing is appropriate.

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