Skip to main content
Glama

Create NeonPlan 3D restore point

neonplan_create_restore_point
Destructive

Save the current state of a NeonPlan 3D plan as a restore point before editing or importing, keeping up to 20 snapshots and dropping the oldest beyond that.

Instructions

Keep the current state of a NeonPlan 3D plan as a restore point; the oldest is dropped beyond 20.

Calls neonplan3d/history/snapshot (admin) and lists the restore points afterwards. The integration keeps at most 20, so with 20 already the oldest is lost.

Use when: before editing the plan in the NeonPlan editor or importing. Not for: before neonplan_save_plan or neonplan_patch_plan — they take one themselves; going back — use neonplan_restore_restore_point. Returns: {"created": true, "plan", "restore_point": {id, revision, saved_at, ...}, "count", "dropped_oldest"}. Errors: neonplan_version_unsupported, 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_create_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).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.29.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true and idempotentHint=false; the description explains why — the 20-point cap silently drops the oldest, and an admin call to neonplan3d/history/snapshot is made followed by a listing. Error codes and the version-gating caveat add genuine context beyond annotations. Minor gap: it doesn't say whether the snapshot survives later restores for long or how concurrency behaves.

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 lead sentence followed by clearly labeled Use when / Not for / Returns / Errors blocks — easy to scan. The 20-point cap is stated twice (first sentence and again in the second paragraph), which is mild redundancy but not harmful.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers timing (before editing/importing), exclusions, error surface, and retention side effect — ample for a 2-parameter mutation. The Returns block is somewhat redundant since an output schema exists, and failure recovery (what to do on admin_required or ha_unreachable) is not addressed.

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 both `plan` and `force` are already documented, including the 3.0.x version-check caveat on `force`. The description adds no parameter-level meaning beyond the schema, so the baseline 3 applies.

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 ('Keep the current state of a NeonPlan 3D plan as a restore point') and immediately adds the retention constraint ('the oldest is dropped beyond 20'). An agent can distinguish this from neonplan_restore_restore_point, neonplan_save_plan, and neonplan_patch_plan without opening any 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?

Includes explicit 'Use when' (before editing in the editor or importing) and 'Not for' clauses that name the alternatives (neonplan_save_plan, neonplan_patch_plan already snapshot; going back needs neonplan_restore_restore_point). Both positive and negative routing conditions are given, leaving nothing to inference.

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