Skip to main content
Glama
Vortitron

home-assistant-mcp

by Vortitron

Validate ESPHome config

esphome_validate
Read-only

Validate an ESPHome configuration to confirm YAML edits are correct before compiling or flashing. Returns validation output to catch errors early.

Instructions

Validate (compile-check) an ESPHome configuration and return the output. The fast way to confirm a YAML edit is correct before compiling or flashing. 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

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds real operational context: it runs over the VomeHome relay with no ports to open, and it tells the agent how to handle an unreachable instance rather than misreporting. Return summarization behavior is useful but partially overlaps the schema.

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

Conciseness5/5

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

Three tightly packed sentences, front-loaded with the core action and then the practical guidance. Every sentence earns its place and none restate the title.

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

Completeness5/5

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

For a non-destructive validate tool with full annotation and schema coverage, the description covers purpose, the pre-compile workflow position, and error remediation. Nothing an agent needs to invoke it correctly is missing, and no output schema is required since the return is 'the output'.

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 all four parameters (full_output, instance_id, configuration, timeout_seconds) are already documented in the schema, setting the baseline at 3. The description references 'return the output' but adds no syntax or format detail beyond what the schema provides.

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

Purpose5/5

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

States a specific verb+resource ('Validate (compile-check) an ESPHome configuration') and immediately frames its scope relative to siblings by saying it's the step before compiling or flashing. An agent can distinguish it from esphome_compile and esphome_upload without opening any schema.

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

Usage Guidelines5/5

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

Explicitly says when to use it ('the fast way to confirm a YAML edit is correct before compiling or flashing'), which implies the alternative (full compile/upload) and the condition selecting this tool. It also routes the agent on failure: use esphome_dashboard_info if ESPHome is unreachable, rather than reporting it unsupported.

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