n8n_diff_workflow

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

No annotations are provided, so the description carries the full behavioral burden. It usefully discloses two traits: "Read-only" and that it "stores nothing," which rules out mutation or side effects. Beyond that it says nothing about whether the live workflow could change mid-diff, how large diffs are returned, or any auth requirements, leaving real gaps for a no-annotation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no filler, with the core action front-loaded and the disambiguating clause second. Every phrase earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description correctly names the return value ("a structured diff"), and it covers the read-only/no-persistence behavior that annotations would otherwise supply. The nested definition parameter is left under-specified, but the description is otherwise sufficient to call the tool correctly.

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

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

Schema description coverage is 0% on two parameters, so the description must compensate. It does clarify the role split — "definition" is the proposed workflow, and the comparison target is the live workflow identified by workflow_id — but adds no format detail for the nested definition object (name/nodes/connections) that the schema leaves undescribed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ("Compare") and resource ("a proposed workflow definition against the live one") plus the return artifact ("a structured diff"), and explicitly contrasts itself with the planning sibling. An agent can distinguish it from n8n_plan_workflow_update and n8n_get_workflow without opening any schema.

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

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

The clause "unlike planning it stores nothing" implies the condition for choosing this tool over n8n_plan_workflow_update, but the guidance is indirect and never states when this tool should be used versus n8n_get_workflow or the backup sibling. Usage is inferable rather than spelled out.

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