Skip to main content
Glama
Vortitron

home-assistant-mcp

by Vortitron

Read ESPHome device logs

esphome_logs
Read-only

Stream live logs from an ESPHome device to inspect boot messages, Wi-Fi/API issues, sensor readings, crashes, and reboot reasons after flashing or when it misbehaves.

Instructions

Stream the live logs from an ESPHome device and return what was captured. This is the way to see what a device is actually doing — boot messages, wifi/API connection problems, sensor readings, crashes and reboot reasons. Use it after flashing, or whenever a device is behaving oddly. Returns once the timeout elapses, so set timeout_seconds to how long you want to watch. 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
portNoDevice address (IP/hostname) or 'OTA' for logs over the network. Defaults to 'OTA'.
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_secondsNoHow long to capture logs for. Defaults to the standard command timeout.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.10.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations declare readOnlyHint/openWorldHint, but the description adds real behavioral context beyond them: it is a streaming call that returns only when the timeout elapses, it runs over the VomeHome relay with no ports to open, and it specifies failure-handling routing. The summarised-vs-full output behavior is largely already covered by the schema, so it falls just short of 5.

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?

Front-loaded with purpose, then usage, timeout behavior, transport, and error routing in logical order. Each sentence carries information, though the description is on the longer side for a five-parameter read tool.

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?

With no output schema, the description carries the burden of explaining returns and does so (captured boot messages, connection problems, sensor readings, crashes), plus timeout semantics and relay transport. Nothing an agent needs to call it correctly is missing.

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 coverage is 100%, so the schema already documents all five parameters. The description only restates timeout_seconds semantics ('set timeout_seconds to how long you want to watch'), which is largely redundant, so the baseline 3 applies.

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 (stream/return logs from an ESPHome device) and enumerates what the logs reveal (boot messages, wifi/API issues, sensor readings, crashes, reboot reasons), which distinguishes it from sibling config/compile/upload tools.

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?

Explicit when-to-use ('after flashing, or whenever a device is behaving oddly') and routes to a named alternative on failure ('run esphome_dashboard_info to see why rather than telling the user this is unsupported'). Nothing left to inference.

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