Skip to main content
Glama
Home Assistant MCP Server

Home Assistant MCP Server

Official

Get Zone

ha_get_zone
Read-onlyIdempotent

Retrieve Home Assistant zone information: list all zones with coordinates and radius, or get detailed configuration for a specific zone by ID or entity ID.

Instructions

Get zone information - list all zones or get details for a specific one.

Without a zone_id: Lists all Home Assistant zones with their coordinates and radius. With a zone_id: Returns detailed configuration for a specific zone.

EXAMPLES:

  • List all zones: ha_get_zone()

  • Get specific zone: ha_get_zone(zone_id="office")

  • Same zone by entity_id: ha_get_zone(zone_id="zone.office")

Zones outside the zone storage, the home zone (from the general settings) and YAML zones, are listed with editable=false / source="yaml"; editable means ha_set_zone and ha_remove_zone can change the zone. Each zone carries its entity_id.

A stored zone's icon is the one stored in the zone, which the Zones editor shows. entity_icon is an icon override in the zone entity's registry entry: the map and the zone's state show it instead. Set or clear the override with ha_set_entity.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "ha_get_zone"
  }
}

Input Schema

NameRequiredDescriptionDefault
zone_idNoZone ID or entity_id to get details for (from the ha_get_zone() list).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv9.0.0
    • changedInput schema / properties / zone_id / description
      Previous value: -"Zone ID to get details for (from ha_get_zone() list)."New value: +"Zone ID or entity_id to get details for (from the ha_get_zone() list)."
  2. Changed1 schema field changedv8.6.0
    • changedInput schema / properties / zone_id / description
      Previous value: -"Zone ID to get details for (from ha_get_zone() list). If omitted, lists all zones."New value: +"Zone ID to get details for (from ha_get_zone() list)."
  3. First observedv7.14.2

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), and the description goes beyond them by explaining that home, YAML and other non-stored zones appear with editable=false / source="yaml", which is exactly the context that determines whether a follow-up write will work. It also flags the subtle icon vs entity_icon split and where each is displayed, though it leaves error behavior for an unknown zone_id unstated.

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 dual-mode behavior is front-loaded, then examples, then edge-case semantics, which is a sensible ordering with no filler sentences. The closing paragraph on icon vs entity_icon is longer than the rest and drifts toward entity-registry detail, but it does document a real gotcha.

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 read tool with a rich output schema and full annotations, the description covers invocation, the two result shapes, and the editability caveat. Only failure modes for an invalid zone_id are absent, and the output schema covers return values, so nothing critical is missing.

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?

With a single parameter and 100% schema coverage, the schema already documents zone_id as a zone ID or entity_id sourced from the ha_get_zone() list, and the description largely repeats that. The examples add modest value by showing both accepted forms ("office" and "zone.office"), but no additional constraints or formats are introduced.

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 and resource ("get zone information") and immediately splits the two operating modes: no zone_id lists all zones with coordinates and radius, with zone_id returns detailed configuration. That is enough for an agent to distinguish it from mutation siblings like ha_set_zone and ha_remove_zone without opening either 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?

It gives concrete invocation contexts through the EXAMPLES block and explicitly names ha_set_zone/ha_remove_zone as the tools that change zones and ha_set_entity as the tool for icon overrides, so the read-only boundary is clear. What is missing is a note on when to prefer this over reading the same data via ha_get_entity or ha_get_state, even though it states each zone carries its entity_id.

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