Skip to main content
Glama

Get NeonPlan 3D status

neonplan_get_status
Read-onlyIdempotent

Check whether NeonPlan 3D is installed and loaded, report version, license, packs, plans, and open screens, and verify no editor is open before saving or running other NeonPlan tools.

Instructions

Report whether NeonPlan 3D is installed and loaded, its version, license, packs, plans and open screens.

Reads the neonplan3d config entry, then neonplan3d/building/get (version), license/get (only whether a license is active), packs/list, plans/list and screens/list (panels and cards open right now — an open editor with unsaved changes would overwrite a save made through nexus). A section the integration refuses holds {"error", ...}. Changes nothing.

Use when: before any other neonplan_* tool, or checking that no editor is open before neonplan_save_plan or neonplan_patch_plan. Not for: the plan itself — use neonplan_get_plan; HACS updates — use hacs_get_hacs_repository. Returns: {"installed", "loaded", "config_entry", "version", "version_warning", "license": {active, error}, "packs": [...], "plans": [...], "screens": [...], "screens_open"}. Errors: neonplan_not_installed (with config_entry when an entry exists but is not loaded), 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_status"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.29.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already cover read-only, idempotent, non-destructive, but the description adds substantive context beyond them: the exact config entry and sub-requests read, that license is reduced to an active/not-active boolean, that an open editor with unsaved changes would overwrite a nexus save, that refused sections hold {error,...}, and 'Changes nothing'.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded statement of purpose, then clearly labelled blocks for internals, use/no-use, return shape and error codes. The enumeration of endpoints and return keys is dense but each item carries real information for correct invocation and interpretation.

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 zero-parameter status probe this is complete: it states the side-effect profile, the data sources, the meaning of degraded sections, the return keys and the two error codes with their distinguishing payload. Nothing needed to call or interpret it 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?

The tool takes zero parameters, so there is no parameter meaning to convey; the baseline for a parameterless tool applies. The description still clarifies that some response sections may hold an error object rather than data, which helps interpretation.

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 full scope: reports install/loaded state, version, license, packs, plans and open screens of NeonPlan 3D. That is concrete enough to distinguish it from neonplan_get_plan or hacs_get_hacs_repository without opening a schema.

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?

Gives explicit 'Use when' guidance (before any other neonplan_* tool; before save/patch to confirm no editor is open) plus explicit exclusions naming the correct alternatives for the plan itself and for HACS updates. Routing is fully determined.

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