Skip to main content
Glama

List Node-RED flows

nodered_list_flows
Read-onlyIdempotent

List Node-RED flows and subflows with node counts and current deploy revision to retrieve flow IDs or get an overview before reading, updating, enabling, or deleting a flow.

Instructions

List the Node-RED add-on's flows (editor tabs) and subflows with node counts and the current deploy rev.

Finds the Node-RED add-on through the Supervisor, then reads GET /flows (Node-RED Admin API v2) on http://127.0.0.1:46836. Changes nothing.

Use when: getting flow ids before nodered_get_flow, nodered_update_flow, nodered_set_flow_enabled or nodered_delete_flow, or an overview. Not for: nodes inside a flow — use nodered_get_flow; HA automations — use automations_list_automations. Returns: {"addon_slug", "rev", "flows": [{id, label, disabled, node_count}], "subflows": [{id, name, node_count, instance_count}], "global_config_nodes", "total_nodes"} in editor tab order. Pass rev as expected_rev to a write tool to refuse it if someone deploys first. Errors: nodered_not_found, nodered_not_running, nodered_unsupported_addon, nodered_unreachable, nodered_auth_required, timeout, HTTP <status>, or a missing SUPERVISOR_TOKEN.

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

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, and the description adds genuine context beyond that: add-on discovery via the Supervisor, the concrete endpoint and loopback address, 'Changes nothing', the rev-based optimistic concurrency contract (pass as expected_rev so a write refuses if someone deploys first), and a full error taxonomy including nodered_auth_required and missing SUPERVISOR_TOKEN.

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?

Purpose, scope, 'Use when', 'Not for', 'Returns', and 'Errors' are cleanly front-loaded and labelled, so an agent can scan it quickly. The literal return-shape dump duplicates the existing output schema and is the one block that does not earn its space.

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-param read tool, the definition covers discovery mechanics, the returned fields and ordering, the concurrency contract, and every failure mode an agent must handle. Nothing needed to call it correctly or recover from an error is missing.

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?

There are zero input parameters, so the schema carries no semantics to add to; the description instead explains how the returned `rev` is consumed as `expected_rev` by write tools, which is useful cross-tool meaning. This exceeds the 0-param baseline of 4 only marginally, since no call-site choices exist to document.

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 first sentence states a specific verb and resource ('List the Node-RED add-on's flows (editor tabs) and subflows') plus the fields returned, and the 'Not for' line explicitly distinguishes it from nodered_get_flow and automations_list_automations. An agent can identify this as the enumeration entry point without ambiguity.

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?

It gives an explicit 'Use when' naming the four downstream write/read tools that need flow ids, plus an 'overview' case, and a 'Not for' clause routing node-level inspection to nodered_get_flow and HA automations elsewhere. Both positive and negative selection criteria 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