flash_firmware

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

The description explains the flashing process, supported formats, and verification. Without annotations, it decently covers behavior but does not explicitly mention destructive nature or potential side effects like overwriting firmware.

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 structured with a title line, supported formats, Arg sections, and return value. It is relatively concise, though some duplication exists (e.g., noting address only for .bin files twice).

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 moderate complexity with 3 parameters and an implied output schema, the description covers all necessary aspects: purpose, formats, parameter guidance, and return value. It is complete for an agent to use correctly.

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%, but the description fully compensates with detailed explanations for each parameter, including examples for file_path, conditional requirement for address, and default for verify. This adds significant value beyond schema titles.

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 '烧录固件到目标单片机 Flash' (Flash firmware to target microcontroller Flash) and lists supported formats, distinguishing this tool from sibling debugger tools like breakpoints and memory operations.

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 guidance on parameter usage (e.g., address needed only for .bin files) and explains when each parameter is required. However, it does not explicitly state when to use this tool versus alternatives or when not to use it.

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