flash_esp32

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

With no annotations, the description carries the full burden. It does disclose a real side effect (closes any open session on the port first) and a safety gate (confirm=true), which is meaningful beyond the schema. However, it omits whether flash is erased, what happens on failure, and any timing or timeout expectations for a hardware write.

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 short clauses with zero filler; the core action is front-loaded and the side effect and confirmation requirement follow compactly. Nothing is wasted.

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 described. The description covers the operation, its destructive side effect, and the confirmation gate, which is most of what an agent needs. The gap is failure/erase semantics for a hardware write.

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% across 6 parameters, so the description must compensate and only partly does: it implies firmware_path (.bin), port (open session on the port), and confirm=true. The baud, chip, and address parameters are left entirely unexplained in both schema and prose.

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 (Flash), resource (.bin firmware), and target (ESP32-family chip) plus the underlying tool (esptool). This cleanly distinguishes it from the sibling flash_stm32, so an agent can route by chip family without opening either schema.

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 ESP32 scoping implies when this tool is appropriate versus flash_stm32, but there is no explicit when/when-not guidance, no mention of session state prerequisites beyond the internal close-session behavior, and no stated alternatives. Usage is inferable rather than stated.

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