Save NeonPlan 3D plan
neonplan_save_planReplace a complete NeonPlan 3D plan for full rebuilds: validate first, enforce revision checks, take a restore point when needed, then save and verify by reading back.
Instructions
Replace a whole NeonPlan 3D plan after validating it, with a restore point and a read-back check.
Runs neonplan_validate_plan (any error blocks), refuses a plan with
floors unless overwrite, checks expected_revision, takes a restore
point (history/snapshot) when the plan has floors, reads the revision
again, sends neonplan3d/building/save and reads the plan back. The
integration itself has no revision check: an editor open with unsaved
changes (see neonplan_get_status screens) can still overwrite this.
Use when: building a plan from scratch or replacing it entirely.
Not for: small edits — use neonplan_patch_plan; undo — use
neonplan_restore_restore_point.
Returns: {"saved": true, "plan", "revision_before", "revision", "snapshot_taken", "verified", "differences", "summary", "warnings"}.
Errors: validation_failed (with errors), plan_not_empty,
revision_conflict, invalid_building (the server's schema refused),
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": {
"building": "<building>"
},
"name": "neonplan_save_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). | |
| building | Yes | The complete building object (version, settings, floors, ...); it replaces the stored one. | |
| overwrite | No | True allows replacing a plan that already has floors; false refuses that. | |
| 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 | |||