Skip to main content
Glama
Vortitron

home-assistant-mcp

by Vortitron

Get one Node-RED flow (tab)

nodered_get_flow
Read-only

Retrieve a single Node-RED flow and its nodes by flow ID. First use nodered_get_flows to discover tab IDs and labels.

Instructions

Get a single Node-RED flow (one editor tab) and its nodes by flow id. Use nodered_get_flows first to discover tab ids and labels.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesFlow (tab) id, e.g. the 'id' of a tab node from nodered_get_flows.
instance_idNoOptional: the instance you mean (as listed by vomehome_list_instances). When given, the call is refused if this session is targeting a different home, instead of answering from it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.10.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description usefully discloses that the response includes the flow plus its nodes (helpful with no output schema), but says nothing about not-found behavior, auth, or the instance-mismatch refusal that only the schema mentions.

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?

Two tight sentences, front-loaded with the core action and followed by the discovery prerequisite. No redundant restatement of the name or title.

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?

For a simple two-parameter read tool with annotations covering safety and a fully described schema, the description supplies what is missing: what the return contains and how to source the id. Only error/edge behavior is left unstated, which is a minor gap.

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 id and instance_id are already documented with examples and refusal semantics. The description's 'by flow id' adds no syntax or format detail 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 (Get), resource (a single Node-RED flow / one editor tab), and explicitly notes it includes the flow's nodes, which distinguishes it from the plural sibling nodered_get_flows and from nodered_list_nodes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear prerequisite ('Use nodered_get_flows first to discover tab ids and labels'), which tells the agent how to obtain the required id. It stops short of stating when-not to use it or naming alternatives for other retrieval needs, so it is strong but not exhaustive.

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