Skip to main content
Glama

List NeonPlan 3D plans

neonplan_list_plans
Read-onlyIdempotent

List NeonPlan 3D floor plans with revision, floor, room and furniture counts, plus bin contents. Use it to choose the plan for other neonplan tools without changing anything.

Instructions

List the NeonPlan 3D floor plans with their revision and floor, room and furniture counts.

Calls neonplan3d/plans/list: the plans in their order (main always exists, others have ids like p0123456789) and the plans in the bin. Changes nothing.

Use when: choosing the plan for the other neonplan_* tools. Not for: one plan's content — use neonplan_get_plan. Returns: {"plans": [{id, name, icon, revision, floors, rooms, furniture, ...}], "trash": [...], "locate_plan"}. Errors: neonplan_not_installed, ha_unreachable, ws_error.

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_list_plans"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

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 readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered, and "Changes nothing" largely restates it. The description still adds real context the annotations lack: the underlying call (`neonplan3d/plans/list`), the guarantee that `main` always exists, that binned plans come back under `trash`, and the enumerated error codes (`neonplan_not_installed`, `ha_unreachable`, `ws_error`).

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?

It is front-loaded with the purpose, then cleanly sectioned into Use when / Not for / Returns / Errors, and no sentence is filler. The one small cost is the "Returns" stanza, which restates shape already available in the 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 no-param read tool with a full annotation set and an output schema, everything an agent needs is present: purpose, selection guidance, the sibling alternative, the underlying endpoint, and the failure modes. The return description is mildly redundant with the output schema but does not leave any gap.

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 add and the baseline applies. The description's mention of `main` and id-shaped plans (`p0123456789`) is useful orientation for the `plan` value an agent will later pass elsewhere, which is about as much as a no-arg tool can offer.

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?

States a specific verb and resource ("List the NeonPlan 3D floor plans") and enumerates the fields carried back (revision, floor/room/furniture counts). It also names the sibling it is not (`neonplan_get_plan`), so an agent can separate listing from fetching a single plan without opening either 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?

An explicit "Use when" clause ties the tool to picking the `plan` value consumed by the other `neonplan_*` tools, and a "Not for" clause routes single-plan reads to `neonplan_get_plan`. Both the positive and negative conditions are spelled out rather than implied.

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