Skip to main content
Glama
Vortitron

home-assistant-mcp

by Vortitron

Add the Vome (vomesync) integration

ha_integration_setup_vome
Destructive

Set up the Vome custom component as a config entry by starting the vomesync config flow and submitting defaults; restart Core after first installing it.

Instructions

Ensure the Vome custom component is set up as a config entry: start the vomesync config flow and submit defaults (new signing key + default sync.vome.io URLs). Idempotent if an entry already exists. Requires Core restart after the add-on first installed custom_components/vomesync. Needs ha:config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidNoOptional switch UID (or uid/access_key) to subscribe on first setup
forceNoIf true, start another flow even when a vomesync entry already exists
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.10.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, openWorldHint=true, and destructiveHint=true. The description adds genuine value beyond them: idempotency semantics, the Core-restart prerequisite, and the required ha:config scope. It does not clarify why destructiveHint is set or what state changes, which keeps it out of 5 territory.

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?

Three tightly packed sentences with the purpose front-loaded, followed by idempotency and prerequisite details. Every sentence carries information, but the dense jargon-heavy phrasing (config flow, sync.vome.io URLs, custom_components path) is slightly terse.

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 zero-required-parameter setup tool with no output schema, the description covers the key prerequisites, idempotency, and auth scope an agent needs to invoke it correctly. Only a note on the expected result of a successful setup is absent, keeping it just below fully complete.

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 three parameters (uid, force, instance_id) are documented in the schema itself, establishing a baseline of 3. The description alludes to defaults being submitted and to idempotency (implying 'force'), but adds no parameter syntax or format detail beyond the schema.

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 and resource: 'Ensure the Vome custom component is set up as a config entry: start the vomesync config flow and submit defaults'. This distinguishes it from sibling tools like ha_addon_install_vome, ha_config_flow, and ha_delete_config_entry without the agent needing to open a schema.

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?

Provides clear operating context: idempotent if an entry already exists, requires a Core restart after the add-on first installed custom_components/vomesync, and needs ha:config scope. It does not explicitly name an alternative sibling (e.g., when to use ha_config_flow instead), so it falls short of a 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