Skip to main content
Glama

Suggest NeonPlan 3D entity bindings

neonplan_suggest_bindings
Read-onlyIdempotent

Suggests which Home Assistant entities in a NeonPlan room's area fit each plan field, grouped by role, without writing changes; use before patching a plan to fill entity fields explicitly.

Instructions

Propose which entities of a NeonPlan room's HA area fit which plan field, without writing anything.

Finds the room in the plan, reads HA's entity and device registries and states, keeps the enabled entities of the room's area_id and groups them by role: blinds → opening.cover, window/door contacts → opening.contact, lights → lamp furniture entity, temperature/ humidity/CO2 sensors → room.climate, climate → radiator/ac_unit, media players → tv_wall, vacuums → robot_vacuum, cameras → pins, locks → opening.lock. Each entity says where the plan already uses it.

Use when: filling entity fields explicitly instead of leaving null (automatic) before neonplan_patch_plan. Not for: the area's entities in general — use areas_get_area_entities. Returns: {"plan", "room": {id, name, area_id}, "openings": [...], "suggestions": {role: {"target", "entities": [{entity_id, name, device_class, used_at}]}}, "unassigned": [entity ids]}. Errors: invalid_plan, plan_not_found, room_not_found, room_has_no_area, neonplan_not_installed, ha_unreachable.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "room_id": "<room_id>"
    },
    "name": "neonplan_suggest_bindings"
  }
}

Input Schema

NameRequiredDescriptionDefault
planNoPlan id from `neonplan_list_plans`; `main` (default) is the plan every install has.main
room_idYesRoom id from `neonplan_get_plan` (summary_only lists them).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.29.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent and non-destructive status, but the description still adds real context: the role-to-field mapping rules, the fact that each entity reports where the plan already uses it, and a concrete error catalog. It does not discuss rate limits or partial-failure behavior, keeping this below a 5.

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-loaded purpose, then a dense role-mapping list, then when/not-for, returns and errors in labeled blocks. The long mapping enumeration is heavy but each entry carries real routing information, so little is wasted.

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?

Output schema exists, yet the description still names the top-level return keys and enumerates the failure modes, so an agent can predict both success and failure shapes. It is thorough; only the absence of guidance on what to do when 'unassigned' is non-empty leaves a small gap.

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 both parameters already document their source ('from neonplan_list_plans', 'from neonplan_get_plan'). The description adds only the implicit fact that room_id must resolve to a room with an area_id, which surfaces via the error list rather than as explicit parameter guidance.

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 ('propose which entities of a NeonPlan room's HA area fit which plan field') and immediately constrains it ('without writing anything'), which separates it from write-side siblings like neonplan_patch_plan.

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' clause ties it to filling entity fields before neonplan_patch_plan, and a 'Not for' clause names the alternative (areas_get_area_entities) for general area entity listing. The decision boundary is unambiguous.

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