Skip to main content
Glama

List Node-RED flow backups

nodered_list_backups
Read-onlyIdempotent

List Node-RED flow backups saved by nexus before each write, newest first, so you can pick a backup_id for restore or review recent changes.

Instructions

List the Node-RED flow backups nexus wrote before its own writes, newest first.

Reads /data/nodered_backups/ inside the nexus add-on (private to nexus, kept with nexus's add-on backup, not under /config). Every nodered_* write tool saves the complete flow list there before it deploys; the newest 30 are kept. No call to Node-RED.

Use when: choosing a backup_id for nodered_restore_backup, or checking what changed recently through nexus. Not for: Supervisor backups of the whole system — use supervisor_list_backups. Returns: {"backups": [{backup_id, created, reason, rev, flow_count, node_count}], "count"}; an unreadable file is listed with error. Errors: none beyond an unreadable file entry; a missing directory returns an empty list.

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": "nodered_list_backups"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.29.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive/closed-world, and the description adds substantial context beyond them: the storage path `/data/nodered_backups/`, that it is private to nexus and not under `/config`, the 30-entry retention cap, and that no call to Node-RED is made. Error behavior (unreadable file entries, empty list on missing directory) is also disclosed.

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?

The labeled sections (Use when / Not for / Returns / Errors) make it easy to scan and the key scoping facts are front-loaded. The parenthetical about nexus's add-on backup and `/config` is slightly verbose but carries real disambiguation value, so it mostly earns its place.

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 read tool, the definition covers purpose, storage semantics, retention, return shape, and error cases. Even though an output schema exists, the inline return sketch and the unreadable-file caveat make the definition self-sufficient for correct invocation and result interpretation.

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 the baseline is 4 by rule. The description still adds useful framing by explaining that the returned `backup_id` values are the input to `nodered_restore_backup`, which connects this read to the consuming write tool.

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?

The description gives a specific verb and resource ("List the Node-RED flow backups nexus wrote before its own writes, newest first") and immediately scopes it away from other backup concepts by naming `supervisor_list_backups` as the alternative. An agent can distinguish this from siblings like `nodered_list_flows` 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?

Explicit "Use when" guidance names the concrete downstream consumer (`nodered_restore_backup` needing a `backup_id`) and a secondary use case (auditing recent changes through nexus). The "Not for" line names the competing tool and its domain (Supervisor system backups), 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