Skip to main content
Glama
Vortitron

home-assistant-mcp

by Vortitron

Create a Home Assistant user

ha_create_user
Destructive

Create a Home Assistant user without sign-in credentials; then call ha_set_user_credentials to set their username and password.

Instructions

Create a new Home Assistant user with no login yet — call ha_set_user_credentials afterwards to give them a username and password, or they exist but cannot sign in.

A user this creates is a standing account on the home, independent of any API key. Deleting the token that created it does not remove the user. Choose 'role' deliberately: 'admin' grants full control of this Home Assistant, equivalent to the owner. Requires ha:config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesDisplay name for the new user.
roleYes'admin' (system-admin, full access), 'user' (system-users, normal dashboard access, no settings), or 'read_only' (system-read-only, cannot change anything).
local_onlyNoRestrict this user to local-network sign-in only (no remote/cloud access).
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.6/5.0
Behavior5/5

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

With annotations covering the safety profile, the description still adds substantial context beyond them: the account is a standing entity independent of the creating API key, deleting the token does not remove the user, admin grants owner-equivalent control, and the call requires the ha:config permission. These are real behavioral traits not present in the structured fields.

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?

The critical fact (no login yet) and the follow-up step are front-loaded, and the persistence warning is bolded for emphasis. Slightly verbose in places ('or they exist but cannot sign in' is an awkward restatement), but nothing is wasted.

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?

For a creation tool with no output schema, the description covers what is produced (an account with no credentials), how to finish the job, the persistence semantics, and the required permission. An agent has everything needed to call it correctly.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds meaning to 'role' by warning that 'admin' is equivalent to the owner and that the choice should be deliberate. It does not elaborate on name or local_only, but those are already well documented in 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 ('Create a new Home Assistant user') and immediately scopes it: the account has no login yet. It also distinguishes itself from ha_set_user_credentials and ha_delete_user by explaining the two-step credential flow and that the user persists after token deletion.

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?

Explicitly tells the agent to call ha_set_user_credentials afterwards to make the account usable, and gives guidance on choosing 'role'. It lacks an explicit when-not or a comparison against alternatives like ha_provision_service_login, but the sequencing guidance is clear and actionable.

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