Skip to main content
Glama

Restore NeonPlan 3D restore point

neonplan_restore_restore_point
Destructive

Revert a NeonPlan 3D plan to a saved restore point and keep the current state as a new restore point; use it to undo a bad plan save or patch.

Instructions

Bring a NeonPlan 3D plan back to a restore point; the integration keeps the current state as a new restore point.

Checks the restore point exists (history/list) and expected_revision, then calls neonplan3d/history/restore (admin), which snapshots the current building and saves the restored one as a new revision.

Use when: undoing a neonplan_save_plan or neonplan_patch_plan that went wrong. Not for: Supervisor backups — use supervisor_restore_backup. Returns: {"restored": true, "plan", "snapshot_id", "revision_before", "revision", "summary"}. Errors: invalid_snapshot_id (no I/O), restore_point_not_found, revision_conflict, neonplan_version_unsupported, invalid_plan, plan_not_found, admin_required, neonplan_not_installed, ha_unreachable.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "snapshot_id": "<snapshot_id>"
    },
    "name": "neonplan_restore_restore_point"
  }
}

Input Schema

NameRequiredDescriptionDefault
planNoPlan id from `neonplan_list_plans`; `main` (default) is the plan every install has.main
forceNoTrue writes even when the integration is not version 3.0.x (format checked by you).
snapshot_idYesRestore point id from `neonplan_list_restore_points`.
expected_revisionNo`revision` from your last read; if the plan's revision differs, nothing is written.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.29.0

TDQS

A4.3/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false and openWorldHint=false, so the safety profile is covered; the description adds useful context that it is an admin operation, that it snapshots the current building as a new revision, and that expected_revision mismatches cause a no-write. It also enumerates failure modes including 'invalid_snapshot_id (no I/O)' and 'admin_required', which is real value beyond the annotations, but it never explains the semantics of the `force` flag or the pre-write validation sequence in depth.

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 purpose followed by tightly labelled Use when / Not for / Returns / Errors blocks; each section carries distinct information an agent needs, with only minor overlap between the opening side-effect sentence and the call-flow sentence.

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?

Covers invocation flow, admin requirement, guard behavior, routing to the Supervisor alternative, and the full error taxonomy, while an output schema already exists so the Returns line is bonus rather than a gap-filler.

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?

Schema description coverage is 100%, so every parameter is already documented in the schema; the description's note that it 'checks the restore point exists and expected_revision' restates the guard rather than adding new meaning. Baseline 3 applies — the schema does the heavy lifting and the `force` flag is left entirely to the schema.

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 ('Bring a NeonPlan 3D plan back to a restore point') plus the non-obvious side effect that the current state is itself preserved as a new restore point, which separates it from a plain overwrite.

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: undoing a neonplan_save_plan or neonplan_patch_plan that went wrong' and 'Not for: Supervisor backups — use supervisor_restore_backup', naming the sibling and the condition that routes to it.

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