Semantic diff between two n8n workflows

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds valuable context: it ignores noise (position deltas, timestamps) and declares deterministic behavior, enhancing the agent's understanding beyond annotations.

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?

The description is concise (five sentences) and front-loaded with the core purpose. Every sentence contributes meaningful information: diff scope, noise filtering, pairing guidance, and determinism.

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?

With an output schema present and the description covering diff categories, noise handling, and pairing advice, the tool is fully contextualized for an agent to invoke 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 coverage is 100% with both parameters documented. The description adds minimal semantic value beyond the schema (e.g., 'workflow JSON'), but the baseline of 3 is appropriate as the schema already defines the parameters.

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?

The description clearly states it performs a semantic diff between two workflows, listing specific diff categories (nodes, connections, settings) and distinguishing itself from siblings by mentioning pairing with workflow_get for deployed vs local comparison.

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 description provides a clear use case ('Pair with workflow_get to compare deployed vs local') but does not explicitly exclude alternatives or state when not to use it. However, the purpose is self-evident for a diff tool.

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