esphome_upload_device

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

With no annotations provided, the description carries full behavioral burden. It discloses that the tool blocks until done (~30-60s) and uses OTA via Dashboard API. It also mentions network and password requirements. However, it lacks details on error behavior or side effects (e.g., device restart).

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 two short, front-loaded sentences. Each sentence adds essential information: purpose, prerequisite, and blocking duration. No redundant words.

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?

The tool has a single parameter and an output schema (not shown, but stated). The description provides core information for using the tool: what it does, prerequisites, and blocking nature. For an OTA flash operation, it covers the most important aspects, though more detail on post-flash state could be included.

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 only parameter 'name' is of type string with no schema description (0% coverage). The tool description implies 'name' refers to the device, but it does not explicitly define the parameter or clarify its format. Given the low schema coverage, the description should compensate but does not.

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 the tool does 'OTA flash compiled firmware to an ESPHome device via Dashboard API'. It specifies the action (flash), method (OTA), and target (ESPHome device). This distinguishes it from sibling tools like esphome_compile_device which compiles but does not flash.

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 prerequisites: 'Requires device on the network and matching OTA password.' It implies the firmware is already compiled, suggesting prior use of esphome_compile_device. However, it does not explicitly state when to use or not use this tool, nor does it mention alternatives (e.g., serial flashing).

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