verify_workflow_lock

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

The description details the behavior: loads lock file, recomputes current lock, diffs models (SHA-256), custom node commits, and ComfyUI version. It also describes the return structure ('empty arrays mean perfect parity'). Requires COMFYUI_PATH. Good transparency given no 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 four sentences, front-loaded with purpose, then method, use case, and output. No fluff; every sentence 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?

With one parameter and no output schema, the description covers functionality, return shape, and use case. Could mention error conditions (e.g., missing file) but overall complete.

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?

Only one parameter 'filename' with schema description; the description adds an example ('my_workflow.json') and clarifies it's from ComfyUI's user library. Adds value beyond 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 clearly states the tool's purpose: 'Compare a saved workflow's lock file against the current state of the local install and report drift.' It specifies the verb 'compare' and the resource, distinguishing it from sibling tools like 'lock_workflow' and 'verify_custom_node'.

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 explicit usage context: 'Use before re-running an important workflow days or weeks later to confirm it'll behave the same.' It does not explicitly mention when not to use it or alternatives, but the use case is clear.

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