Skip to main content
Glama
Vortitron

home-assistant-mcp

by Vortitron

Get Node-RED flows

nodered_get_flows
Read-only

Retrieve the complete Node-RED flow JSON plus its revision string, so you can pass the rev back when writing flows and avoid overwriting concurrent edits.

Instructions

Get the full Node-RED flow configuration (the JSON array of all nodes across every tab) plus the current revision string. Pass that 'rev' back to nodered_set_flows to avoid clobbering a concurrent change. Prefer nodered_get_flow / nodered_update_flow for single-tab edits.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered. The description adds genuinely useful behavioral context beyond that: it returns a 'rev' string and explains the concurrency hazard (clobbering a concurrent change) that the rev guards against. It stops short of describing size/pagination behavior for large flow sets.

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: the return payload and revision are front-loaded, the concurrency purpose follows, and the sibling routing hint closes. No redundant 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?

No output schema exists, so the description carries the burden of describing returns — and it does, naming the JSON node array and the revision string. Combined with the routing guidance and the annotation-covered safety profile, an agent has everything needed to call this correctly.

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% and there is a single optional instance_id parameter, which the description does not mention at all. With the schema fully documenting the parameter, the baseline of 3 applies; the description neither adds nor detracts.

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 ('Get the full Node-RED flow configuration') and defines the scope precisely as 'the JSON array of all nodes across every tab' plus the revision string. It also explicitly distinguishes itself from the sibling single-tab tools, so an agent can route correctly without opening a 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?

Gives explicit when-to-use ('pass that rev back to nodered_set_flows to avoid clobbering a concurrent change') and when-not-to-use ('prefer nodered_get_flow / nodered_update_flow for single-tab edits'). Both the alternative and the condition selecting it are named, 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