Skip to main content
Glama

List NeonPlan 3D restore points

neonplan_list_restore_points
Read-onlyIdempotent

Lists a NeonPlan 3D plan's saved restore points, newest first, so you can pick a snapshot_id to restore. Reads history only and changes nothing.

Instructions

List a NeonPlan 3D plan's restore points (at most 20 kept), newest first.

Calls neonplan3d/history/list (admin). The integration adds one by itself on a save when the last is older than 10 minutes; the neonplan_* write tools take one before every save. Changes nothing.

Use when: picking snapshot_id for neonplan_restore_restore_point. Not for: nexus's Node-RED backups — use nodered_list_backups; HA backups — use supervisor_list_backups. Returns: {"plan", "restore_points": [{id, revision, saved_at, saved_at_iso, floors, rooms, furniture}], "count", "max"}. Errors: invalid_plan, plan_not_found, admin_required, 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_list_restore_points"
  }
}

Input Schema

NameRequiredDescriptionDefault
planNoPlan id from `neonplan_list_plans`; `main` (default) is the plan every install has.main

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.29.0

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the read-only/idempotent annotations the description discloses retention semantics (max 20 kept, newest first), the automatic snapshot policy (one added on save when the last is over 10 minutes old, and write tools snapshot before every save), the underlying admin endpoint, and that admin rights are required via the `admin_required` error. This is substantive behavior an agent could not infer from the structured fields.

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 with the scope sentence, then cleanly segmented into behavior, Use when / Not for, Returns, and Errors. Every line carries information; the "Changes nothing" line is the only mildly redundant piece against the readOnly annotation.

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 single-optional-parameter read tool, the definition covers scope, retention, auth requirements, triggering use case, alternatives, and a full error list. The Returns block restates the output schema but harmlessly reinforces the shape of `restore_points`.

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

Parameters3/5

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

There is a single parameter at 100% schema coverage, so the schema already explains that `plan` defaults to `main` and comes from `neonplan_list_plans`. The description adds no further detail about the parameter's format or behavior, which is the expected baseline when the schema carries the load.

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 a NeonPlan 3D plan's restore points") plus scope constraints (at most 20 kept, newest first). The reader immediately knows this is a read of a bounded, ordered history list, and it is distinct from the restore/creation siblings by name.

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?

Explicit "Use when" clause ties it to picking a `snapshot_id` for `neonplan_restore_restore_point`, and "Not for" excludes two concrete alternatives by name (`nodered_list_backups`, `supervisor_list_backups`). Both the positive trigger and the disambiguation are spelled out.

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