Get NeonPlan 3D plan
neonplan_get_planReads a single NeonPlan 3D building plan as the full object with revision or a compact summary, so you can inspect it before editing.
Instructions
Read one NeonPlan 3D plan: the whole building object with its revision, or a compact summary.
Calls neonplan3d/building/get. The full building is the object
neonplan_save_plan takes and neonplan_patch_plan paths point into
(units metres, points [x, z], z grows down the drawing). The summary
lists per floor its rooms (id, name, area_id, corner count), openings
(id, type, room_id, edge, offset) and the entity ids the plan references.
Changes nothing.
Use when: reading the plan before an edit; keep revision for
expected_revision.
Not for: the list of plans — use neonplan_list_plans; checking a plan
— use neonplan_validate_plan.
Returns: {"plan", "revision", "version", "version_warning", "building"}
or, with summary_only, {"plan", "revision", "version", "version_warning", "totals", "floors": [...], "entities": [...]}.
Errors: invalid_plan (no I/O), plan_not_found,
neonplan_not_installed, ha_unreachable.
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": "neonplan_get_plan"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | No | Plan id from `neonplan_list_plans`; `main` (default) is the plan every install has. | main |
| summary_only | No | True returns floors, rooms (with area_id), openings and bound entities instead of the full building. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||