Get VomeHome one-click login URL

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

Annotations only declare readOnlyHint and openWorldHint. The description adds important behavioral context beyond that: the URL embeds a short-lived credential, must be treated as a secret, must not be logged, and requires VOMEHOME_TOKEN. This is exactly the extra security and auth guidance an agent needs.

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?

The description is four short sentences, front-loaded with the tool's purpose. Every sentence carries necessary information: what it returns, how to present it, security handling, and auth requirement.

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?

For a one-parameter read-only tool with no output schema, the description is complete. It explains the return value, how to use it, and the required credential, leaving no critical gaps for correct invocation.

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%, and the single instance_id parameter is fully documented in the schema. The description does not add further meaning about the parameter, so it meets the baseline where the schema does the heavy lifting.

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?

The description uses a specific verb (get) and resource (one-click login URL) and states the outcome clearly: it opens the VomeHome Home Assistant already signed in. This is distinct from sibling tools such as vomehome_create_guest_link or vomehome_use_instance, so an agent can identify its unique role.

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?

The description provides clear usage context: return the URL to the user for opening in a new tab/window. It does not explicitly name alternatives or when-not-to-use conditions, but the operational context is unambiguous.

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