Skip to main content
Glama
Vortitron

home-assistant-mcp

by Vortitron

Get ESPHome config

esphome_get_config
Read-only

Read the YAML for an ESPHome configuration file by name, such as 'living-room.yaml', to inspect device settings before validating or compiling.

Instructions

Read the YAML for an ESPHome configuration file (e.g. 'living-room.yaml').

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.10.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds only that the target is YAML plus a filename example, and does not disclose return format, error behavior, or whether a missing file errors out.

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?

A single efficient sentence with no padding. It is front-loaded and each clause earns its place, though it is arguably under-specified rather than maximally concise.

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?

For a simple read-only tool with full schema coverage and annotations carrying the safety profile, the description is nearly sufficient. The main gap is the absence of a hint about what is returned (raw YAML contents) since there is no output schema.

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 both parameters are already documented, including the instance_id scoping/refusal semantics. The description repeats the filename example already present in the schema and adds no new parameter meaning.

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?

The description states a specific verb (Read) and resource (the YAML for an ESPHome configuration file), which implicitly separates it from esphome_save_config and esphome_edit_config. It does not explicitly name or contrast 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 Guidelines2/5

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

There is no explicit when-to-use or when-not-to-use guidance. The contrast with esphome_edit_config / esphome_save_config is only inferable from the word 'Read', leaving the agent to reason about selection on its own.

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