Skip to main content
Glama

Get NeonPlan 3D plan

neonplan_get_plan
Read-onlyIdempotent

Reads 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

NameRequiredDescriptionDefault
planNoPlan id from `neonplan_list_plans`; `main` (default) is the plan every install has.main
summary_onlyNoTrue returns floors, rooms (with area_id), openings and bound entities instead of the full building.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.29.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, yet the description adds the underlying call path, units in metres, the `[x, z]` point convention with z growing down, and the relationship to `neonplan_save_plan`/`neonplan_patch_plan`. It also enumerates error cases (`invalid_plan` with no I/O, `plan_not_found`, `neonplan_not_installed`, `ha_unreachable`), which is behavior the annotations cannot convey.

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 with the core action, then labeled Use when / Not for / Returns / Errors blocks that are easy to scan. It is information-dense and nearly every sentence earns its place, though the verbose Returns enumeration partially duplicates the existing output schema.

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?

For a read tool with two optional params, the definition covers modes, coordinate conventions, downstream compatibility, and all documented failure modes. Nothing an agent needs to call it correctly and interpret the result is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3, but the description goes further by explaining what `summary_only` actually yields (floors, rooms with area_id, openings, bound entities) and framing the full building as the object `save_plan` consumes and `patch_plan` paths target. It ties the parameters to downstream tools rather than merely restating types.

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?

Opens with a specific verb and resource ("Read one NeonPlan 3D plan") and immediately distinguishes the two modes (full building vs compact summary). It also names the sibling tools it is not, so an agent can separate this from list/validate without opening schemas.

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?

Contains explicit "Use when" (read before an edit, keep `revision` for `expected_revision`) and "Not for" clauses routing to `neonplan_list_plans` for listing and `neonplan_validate_plan` for checking. Both the when and the when-not are stated outright.

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