Skip to main content
Glama

Create zone helper

zones_create_zone

Creates a new geofence zone in Home Assistant's storage collection, enabling later updates or deletion without editing configuration.yaml.

Instructions

Create a zone as a UI helper (storage collection), not a YAML zone.

Calls WS zone/create with the given coordinates and radius; only zones created this way can later be changed through zones_update_zone or zones_delete_zone. zone.home (core config) and YAML-defined zones live outside this storage collection and cannot be created here.

Use when: adding a new geofence zone without editing configuration.yaml. Returns: dict with status, name, and the raw WS result. Errors: on failure, returns {"error": "<message>", "hint": "...", "name": ...} instead of raising.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
iconNoOptional mdi icon identifier, e.g. 'mdi:office-building'; omit for none.
nameYesDisplay name for the new zone, e.g. 'Office'.
radiusNoZone radius in meters; defaults to 100.
passiveNoIf true, excludes the zone from device-tracker zone suggestions; defaults to false.
latitudeYesLatitude in decimal degrees, e.g. 52.23.
longitudeYesLongitude in decimal degrees, e.g. 21.01.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.25.1
    • addedInput schema / properties / icon / description
      Added value: +"Optional mdi icon identifier, e.g. 'mdi:office-building'; omit for none."
    • addedInput schema / properties / latitude / description
      Added value: +"Latitude in decimal degrees, e.g. 52.23."
    • addedInput schema / properties / longitude / description
      Added value: +"Longitude in decimal degrees, e.g. 21.01."
    • addedInput schema / properties / name / description
      Added value: +"Display name for the new zone, e.g. 'Office'."
    • addedInput schema / properties / passive / description
      Added value: +"If true, excludes the zone from device-tracker zone suggestions; defaults to false."
    • addedInput schema / properties / radius / description
      Added value: +"Zone radius in meters; defaults to 100."
  2. First observedv0.3.0

TDQS

A4.7/5.0
Behavior5/5

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

With annotations already covering safety hints (readOnlyHint=false, destructiveHint=false), the description adds substantial behavioral context: it discloses the underlying WS call (zone/create), the persistence constraint that only zones created this way can be updated/deleted later, the return shape (status, name, raw WS result), and error behavior (returns an error dict instead of raising). This goes well beyond what annotations provide.

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?

The description is front-loaded with the core purpose and distinction, then flows into behavioral details, usage guidance, return values, and error handling in a logical order. Every sentence carries useful information without waste.

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?

Given a create mutation with full annotation coverage and an output schema, the description is complete: it explains purpose, usage context, behavioral constraints, return format (though output schema exists, the description still clarifies), and error handling. No critical gaps remain for an agent to call the tool correctly.

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 the schema itself fully documents all six parameters with examples and defaults. The description only alludes to 'given coordinates and radius', adding no new semantic information beyond the schema. A baseline 3 is appropriate when the schema does the heavy lifting.

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?

The description states a specific verb (Create) and resource (zone), and explicitly distinguishes it from YAML zones and from the update/delete siblings by noting that only zones created this way can later be changed through zones_update_zone or zones_delete_zone. An agent can immediately tell what the tool does and how it differs from related tools.

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

Usage Guidelines5/5

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

It gives explicit usage guidance ('Use when: adding a new geofence zone without editing configuration.yaml') and clear exclusions ('zone.home (core config) and YAML-defined zones live outside this storage collection and cannot be created here'). The alternative approach (editing configuration.yaml) is named, leaving no ambiguity about when to choose this tool.

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