Skip to main content
Glama
FarazHayder

n8n-mcp-guard

by FarazHayder

n8n_plan_workflow_update

Generate a reviewable plan before updating an n8n workflow: reads and backs up the live version, diffs it against your proposal, and returns a plan_id and diff—no changes made.

Instructions

Phase 1 of a guarded update. Reads the live workflow, backs it up, diffs it against your proposed definition, and returns a plan_id plus a structured diff to review. Changes nothing in n8n. Pass the plan_id to n8n_apply_workflow_update to commit.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
definitionYes
workflow_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.1

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses that it reads the live workflow, takes a backup, computes a diff, returns a plan_id plus structured diff, and critically that it 'Changes nothing in n8n.' It omits auth/permission requirements and any rate or size considerations, so it stops short of a 5.

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?

Four short sentences, zero waste, and the most decision-relevant facts (phase, read-only, next step) are front-loaded. Nothing is repeated from the schema or filler.

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?

No output schema exists, and the description helpfully states what comes back (plan_id + structured diff) and that state is unchanged, which is the key decision input for an agent. The remaining gap is parameter/definition shape, which neither the schema nor the description explains.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and 'definition' is a required nested object, so the description must compensate but largely does not. It only alludes to 'your proposed definition' and never explains workflow_id, nor the required name/nodes/connections shape the nested object expects.

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+resource ('plan workflow update') and delimits it with a precise scope: reads, backs up, diffs, returns a plan_id. It explicitly separates itself from the commit phase by naming n8n_apply_workflow_update, so an agent can distinguish it from n8n_diff_workflow and n8n_backup_workflow 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 an explicit two-phase workflow: call this first ('Phase 1'), then 'Pass the plan_id to n8n_apply_workflow_update to commit.' The condition that selects this tool over its siblings is stated outright, and the follow-on action is named.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.