Compare workflow versions

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

Beyond the annotations (readOnly, idempotent, non-destructive), the description adds critical behavioral details: it returns 'coverage, counts, and a byte-bounded prefix of up to 200 changes,' requires 'workflow/history read permission,' and clarifies that ignoreLayout hides position-only changes. This goes well beyond the structured data.

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 three sentences, front-loaded with the core purpose, and every sentence adds essential information. There is no redundancy or padding. It efficiently packs parameter semantics, alternatives, permissions, and output characteristics into a compact, readable format.

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?

Given the output schema and 100% parameter schema coverage, the description complements rather than repeats structured data. It mentions the high-level return values (coverage, counts, prefix) and permission requirements, making the tool's behavior fully understood without over-explaining. The context signals and sibling list further support usage decisions.

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?

While the schema descriptions already cover 100% of the parameters, the description enriches their meaning by explaining relationships: workflowId selects the workflow, fromVersionId is the retained baseline, toVersionId is an optional target, and omitting toVersionId compares with current state. It also clarifies the semantics of ignoreLayout. This adds significant value over the schema.

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 opens with a specific verb and resource: 'Compare two states of one workflow without returning changed values.' This clearly defines the tool's function. It also distinguishes from the sibling tool by explicitly directing users to n8n_workflows_get_version for raw history, making the purpose unambiguous.

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 clear context for when to use the tool, such as omitting toVersionId to compare with the current state, and names an alternative (n8n_workflows_get_version) for raw history. However, it does not explicitly state when NOT to use this tool, but the guidance is sufficient for effective selection.

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