Create VomeHome instance

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

Annotations only say it is not read-only and is open-world; the description goes well beyond by disclosing that the creating API key receives full HA access (ha:read/write/config/files) and that the new instance silently becomes the active target — a consequential side effect. It also explains the authorization model in brokered mode and the local opt-out flag.

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

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

Front-loads purpose in the first clause, then layers scope/authorization/side-effect notes. Four dense sentences with no filler, though the env-flag detail is somewhat operational for a tool description.

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

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

Covers auth requirements, the opt-out switch, and the active-target side effect, which is what an agent most needs before a mutating call. With no output schema, the return value (e.g. new instance id) and post-create next steps are left unspecified, a minor gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% (name and timezone are both documented in-schema), so the baseline is 3. The description adds no format or defaulting detail for either parameter (e.g. timezone default, name uniqueness), so it does not earn above baseline.

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

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

States a specific verb and resource ('Create a new Home Assistant instance on VomeHome') and no sibling offers creation, so the agent can distinguish it from vomehome_list_instances/get_instance/use_instance without opening a schema. The sandbox/test framing further sharpens the intent.

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

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

Gives a clear use context ('throwaway test/sandbox install') and a blocking mechanism via VOMEHOME_ALLOW_CREATE=false. It stops short of explicitly contrasting with vomehome_use_instance, which an agent might plausibly reach for when it only wants to target an existing instance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.