Patch NeonPlan 3D plan
neonplan_patch_planEdit part of an existing NeonPlan 3D plan using JSON Patch operations, then validate and save it with revision guards and a restore point. Use it to bind entities, add lamps or windows, or rename rooms.
Instructions
Change part of a NeonPlan 3D plan with JSON Patch operations, then validate and save it like neonplan_save_plan.
Reads the plan, applies the operations to a copy (a failing operation,
including a failed test, stops everything), validates the result
(errors block) and saves it with the same guards as
neonplan_save_plan: expected_revision, restore point, revision
re-check, read-back. An operation on path "" (the whole plan) needs
overwrite=true when the plan has floors, like neonplan_save_plan.
Use when: binding an entity, adding a lamp or window, renaming a room —
any edit of an existing plan.
Not for: a new plan from scratch — use neonplan_save_plan; checking
paths first — read with neonplan_get_plan.
Returns: like neonplan_save_plan, plus "operations" (count).
Errors: invalid_patch (with operation index), validation_failed,
plan_not_empty (whole-plan operation without overwrite), revision_conflict, invalid_building, neonplan_version_unsupported,
invalid_plan, plan_not_found, admin_required,
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": {
"operations": "<operations>"
},
"name": "neonplan_patch_plan"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | No | Plan id from `neonplan_list_plans`; `main` (default) is the plan every install has. | main |
| force | No | True writes even when the integration is not version 3.0.x (format checked by you). | |
| overwrite | No | True allows an operation on path '' (the whole plan) when the plan has floors, as save_plan. | |
| operations | Yes | JSON Patch (RFC 6902) operations on the building, applied in order, e.g. `[{"op": "replace", "path": "/floors/0/openings/2/cover", "value": "cover.blind_kitchen"}, {"op": "add", "path": "/floors/0/furniture/-", "value": {...}}]`; ops add, remove, replace, move, copy, test. | |
| expected_revision | No | `revision` from your last read; if the plan's revision differs, nothing is written. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||