Skip to main content
Glama
Vortitron

home-assistant-mcp

by Vortitron

Get VomeHome instance

vomehome_get_instance
Read-only

Fetch a VomeHome instance by UUID to view live status and Home Assistant URL. Use the instance id returned by the list instances call.

Instructions

Get one VomeHome instance by id, including live status and the Home Assistant URL. Requires VOMEHOME_TOKEN.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
instance_idYesVomeHome instance id (UUID), as returned by vomehome_list_instances.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.10.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so safety is covered. On top of that the description discloses the auth requirement (VOMEHOME_TOKEN) and the nature of the returned data (live status, HA URL), which is meaningful added context for an open-world read.

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?

One compact sentence with the action, scope, and return content front-loaded, followed by the auth caveat. No filler.

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 single-parameter, read-only lookup with no output schema, the description covers what it retrieves and the token requirement. It could be marginally stronger by noting failure behavior for an invalid id, but nothing essential 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% and the single instance_id parameter is fully documented as a UUID from vomehome_list_instances. The description's 'by id' adds no format or source detail beyond what the schema already provides, so baseline 3 applies.

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 ('Get one VomeHome instance by id') plus what the result contains (live status and the Home Assistant URL). Sibling differentiation from vomehome_list_instances is implied by 'one ... by id' but the sibling is not named explicitly.

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

Usage Guidelines3/5

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

Usage is implied (fetch a single instance's details once you have its id from the list tool), and the description states the auth prerequisite ('Requires VOMEHOME_TOKEN'). It gives no explicit when-not conditions or pointer to the alternative tool for listing.

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