n8n_diff_workflow_snapshot

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

With readOnlyHint=true already signaling a safe read operation, the description adds useful behavioral context by specifying what the diff reports: changed nodes, parameters, and connections. It aligns with the read-only annotation and gives the agent a clear picture of the tool's non-mutating scope.

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 tight sentences: the first defines the operation and its scope, the second provides usage context. No filler or redundant restatement of the tool name.

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?

For a read-only diff tool with well-documented parameters, the description is largely complete. It names the comparison dimensions even without an output schema, so an agent can anticipate the kind of result. Minor gap: the exact return format is not described, but this is not critical for selecting and invoking the tool.

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 100%, and the parameter descriptions already explain id, to, and from with defaults. The description adds little beyond what the schema states, so the baseline of 3 is appropriate.

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, 'Compare', and names the exact resources: a workflow snapshot versus the current state or another snapshot. It enumerates what the comparison covers (nodes added/removed/modified, changed parameters, connection changes), making it easy to distinguish from sibling tools like n8n_list_workflow_snapshots or n8n_rollback_workflow.

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 gives a clear use context: 'Useful before deciding whether to roll back.' This implicitly positions it as a decision-support tool rather than a mutation tool, though it does not explicitly name alternatives or when-not-to-use conditions.

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