Skip to main content
Glama
Vortitron

home-assistant-mcp

by Vortitron

Compile ESPHome firmware

esphome_compile

Compile firmware for an ESPHome configuration and return build output, including errors, warnings, and memory use. Use before flashing to verify the build succeeds.

Instructions

Compile firmware for an ESPHome configuration and return the build output. Can take several minutes. Runs over the VomeHome relay — no ports to open. If a call reports that ESPHome is unreachable, run esphome_dashboard_info to see why rather than telling the user this is unsupported.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
full_outputNoReturn every line of output. By default a long output comes back summarised: all errors and warnings, memory use, and the last lines.
instance_idNoOptional: the instance you mean (as listed by vomehome_list_instances). When given, the call is refused if this session is targeting a different home, instead of answering from it.
configurationYesConfiguration filename, e.g. 'living-room.yaml'.
timeout_secondsNoOverride the command timeout.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.10.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=false and openWorldHint=true; the description adds real context beyond them — expected latency of several minutes, that the work runs over the VomeHome relay with no open ports, and how unreachable errors should be handled. It does not describe build-artifact side effects or timeout behavior, but the added operational detail is substantial.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four sentences, front-loaded with the core purpose and artifact, followed by latency, transport note, and error routing. Nothing is redundant, though the relay/ports sentence is slightly tangential to selecting or calling the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the return-value burden and does so adequately: build output, summarised-by-default behavior is covered by the schema, latency is flagged, and the failure path is routed. Only the exact failure/timeout semantics of a failed compile are left unstated.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents configuration, full_output, instance_id, and timeout_seconds in detail. The description adds no parameter-level meaning beyond what the schema provides, which makes the baseline 3 correct.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Compile firmware for an ESPHome configuration') plus the return artifact ('build output'), which is enough to distinguish it from siblings like esphome_validate, esphome_upload, and esphome_clean. It does not explicitly name those siblings, so it stops short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear operational context ('Can take several minutes') and an explicit failure-routing rule: if ESPHome is unreachable, call esphome_dashboard_info rather than reporting it as unsupported. It lacks guidance on when to compile vs validate or upload, so it is not a full 5.

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

Deploy Server

Other Tools