Skip to main content
Glama

Get Zone

ha_get_zone
Read-onlyIdempotent

Retrieve Home Assistant zones: 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.

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. First observedv9.2.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive), yet the description still adds real value: zones outside zone storage, the home zone, and YAML zones come back with editable=false / source="yaml", and each zone carries its entity_id. That editable-flag semantics is non-obvious behavior an agent needs before deciding whether to attempt a write.

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?

Front-loads the two modes before examples, and the editable/YAML paragraph is placed last where it belongs. The final paragraph is a bit dense and slightly awkwardly worded, but nothing is wasted at the sentence level.

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 one-optional-param read tool with annotations and an output schema, this is nearly complete: both modes' returns are described conceptually and the editable flag is explained. Only a clearer statement of what detail fields a specific-zone response contains (beyond entity_id) is missing, and the output schema likely covers that.

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 goes further by showing that zone_id accepts both a bare ID ('office') and an entity_id ('zone.office'), which is a real ambiguity the schema leaves open. The examples resolve it concretely.

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 ('Get zone information') and splits the behavior cleanly into two modes: list-all without zone_id, detailed config with zone_id. An agent can immediately tell this apart from sibling mutators like ha_set_zone and ha_remove_zone.

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?

The no-arg vs. with-arg distinction is explicit, concrete examples are given for both list and detail calls, and the editable/source note implicitly routes the agent to ha_set_zone/ha_remove_zone for changes. It lacks an explicit 'do not use this to modify zones' exclusion, but the context is clear.

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