esphome_compile_device

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

Discloses blocking behavior and approximate runtime, and mentions the API used. With no annotations, this is adequate but could note side effects like file creation.

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, no wasted words, front-loaded with purpose. Highly concise and well-structured.

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?

Covers purpose, blocking, duration, and API. Missing prerequisites like valid config or device existence, but output schema likely fills gaps.

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?

Single 'name' parameter is not explained beyond the context of 'device'. Schema coverage is 0%, so description should clarify what 'name' refers to (e.g., device name, config name).

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?

Description clearly states the action (compile), resource (ESPHome firmware), method (Dashboard API), and blocking behavior. Differentiates from siblings like validate or upload.

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?

Provides expected duration (60-120s) implying it's a heavy operation, but does not explicitly state when to use vs alternatives like esphome_validate_config or prerequisites.

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