Skip to main content
Glama
Fistacho

ha-nexus-agent

by Fistacho
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Update zone helper

zones_update_zone
Destructive

Update an existing UI-helper zone's coordinates, radius, name, or icon. Only works for zones created via zones_create_zone; YAML zones and zone.home are rejected.

Instructions

Update fields on an existing zone helper.

Calls WS zone/update; only the parameters you pass are sent, so omitted fields keep their current value. Only works for zones created via zones_create_zone (UI helpers) — zone.home and YAML-defined zones reject this WS command.

Use when: adjusting a UI-helper zone's coordinates, radius or name. Returns: dict with status, zone_id, and the raw WS result. Errors: on failure (e.g. a YAML zone or zone.home), returns {"error": "<message>", "hint": "...", "zone_id": ...} instead of raising.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
iconNoNew mdi icon identifier; omit to leave the current icon unchanged.
nameNoNew display name; omit to leave the current name unchanged.
radiusNoNew zone radius in meters; omit to leave the current radius unchanged.
passiveNoNew passive flag; omit to leave the current setting unchanged.
latitudeNoNew latitude in decimal degrees; omit to leave the current latitude unchanged.
entity_idYesZone entity_id to update, e.g. 'zone.office'; obtain it from zones_list_zones.
longitudeNoNew longitude in decimal degrees; omit to leave the current longitude unchanged.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.25.1
    • addedInput schema / properties / entity_id / description
      Added value: +"Zone entity_id to update, e.g. 'zone.office'; obtain it from zones_list_zones."
    • addedInput schema / properties / icon / description
      Added value: +"New mdi icon identifier; omit to leave the current icon unchanged."
    • addedInput schema / properties / latitude / description
      Added value: +"New latitude in decimal degrees; omit to leave the current latitude unchanged."
    • addedInput schema / properties / longitude / description
      Added value: +"New longitude in decimal degrees; omit to leave the current longitude unchanged."
    • addedInput schema / properties / name / description
      Added value: +"New display name; omit to leave the current name unchanged."
    • addedInput schema / properties / passive / description
      Added value: +"New passive flag; omit to leave the current setting unchanged."
    • addedInput schema / properties / radius / description
      Added value: +"New zone radius in meters; omit to leave the current radius unchanged."
  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?

Annotations declare destructiveHint=true, but the description goes well beyond them by disclosing PATCH semantics ('only the parameters you pass are sent, so omitted fields keep their current value'), the scope restriction on which zones accept the WS command, the return shape, and the non-raising error contract. This is substantive behavioral context 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded purpose sentence, then behavior, then use-when, then returns, then errors — each block earns its place with no filler. Size is proportionate to a 7-param mutation tool with non-obvious scope constraints.

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?

Covers purpose, scope limits, partial-update behavior, use conditions, return shape, and error contract. Although an output schema exists, the explicit error-shape disclosure (error/hint/zone_id instead of raising) is exactly the kind of exception an agent must handle and is included.

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 coverage is 100% and each property already documents its 'omit to leave unchanged' behavior, so the schema carries the burden. The description's partial-update sentence reinforces this but adds little syntax or format detail beyond structured fields. Baseline 3 is appropriate.

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?

Specific verb+resource ('Update fields on an existing zone helper') with immediate scope qualification naming what it does NOT apply to (zone.home, YAML zones). An agent can distinguish it from zones_create_zone, zones_delete_zone, and zones_reload_zones without opening a schema.

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?

Explicit 'Use when: adjusting a UI-helper zone's coordinates, radius or name' plus an exclusion ('only works for zones created via zones_create_zone — zone.home and YAML-defined zones reject this WS command'). Both when-to-use and when-not-to-use are stated, with the sibling to route to for unsupported cases.

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