Skip to main content
Glama

Get one Node-RED flow

nodered_get_flow
Read-onlyIdempotent

Read one Node-RED flow tab with all its nodes, groups, and junctions, with secrets replaced by a placeholder ready for editing. Returns the flow, revision, and redacted fields without changing anything.

Instructions

Read one Node-RED flow (editor tab) with all its nodes, secrets replaced by a placeholder.

Reads GET /flows and returns the tab plus every node whose z is this tab (regular nodes, config nodes scoped to the tab, groups, junctions). Node credentials are never in Node-RED's answer; fields that look secret (password, token, apikey, URLs with user:pass@) come back as the redaction placeholder and are listed in redacted_fields. Changes nothing.

Use when: inspecting a flow, or reading it before nodered_update_flow (placeholders sent back unchanged keep their stored value). Not for: the list of flows — use nodered_list_flows; finding nodes across flows — use nodered_search_nodes or nodered_find_entity_usage. Returns: {"addon_slug", "rev", "flow": {id, label, disabled, info, env}, "nodes": [...], "node_count", "redacted_fields"}. Errors: flow_not_found, plus the add-on lookup errors of nodered_list_flows. Limits: secrets typed into function code or templates are not detected.

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": {
      "flow_id": "<flow_id>"
    },
    "name": "nodered_get_flow"
  }
}

Input Schema

NameRequiredDescriptionDefault
flow_idYesFlow (tab) id from `nodered_list_flows`, e.g. `a1b2c3d4e5f60718`.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.29.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already cover the read-only/idempotent/non-destructive profile, and the description goes well beyond them: it states that node `credentials` never appear in Node-RED's response, that secret-looking fields are replaced by a placeholder and enumerated in `redacted_fields`, and it discloses a real limitation (secrets embedded in function code or templates are not detected). It also lists concrete error codes and notes that nothing changes.

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 one-line summary, then labeled sections (Use when / Not for / Returns / Errors / Limits) that make skimming trivial. Every line carries distinct information — the redaction rule, the round-trip caveat, and the detection limit are all load-bearing — with no restatement of the tool name or annotations.

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?

Although an output schema exists, the description still gives a compact return-shape sketch plus the `redacted_fields` semantics that the schema alone would not convey. Combined with error codes, limitations, and update-workflow guidance, nothing material is missing for a one-parameter read tool.

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?

Schema coverage is 100% and the single `flow_id` parameter is already documented with a format example, so the baseline is 3. The description adds a little genuine meaning by framing the flow as an editor tab and by specifying the acceptable id source in the usage section, but it does not restate format details beyond 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?

Opens with a specific verb and resource — "Read one Node-RED flow (editor tab) with all its nodes" — and immediately clarifies the scope (the tab plus every node whose `z` is that tab). The parenthetical "(editor tab)" disambiguates what a "flow" is in this API, which an agent could otherwise confuse with the whole flow set.

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" and "Not for" blocks name the precise alternatives: `nodered_list_flows` for the list, `nodered_search_nodes` / `nodered_find_entity_usage` for cross-flow lookup. It also flags the read-before-`nodered_update_flow` workflow and the placeholder round-trip contract, which is non-obvious routing information an agent needs.

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