verify_workflow_lock

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

Describes the comparison process in detail (loads lock, recomputes, diffs SHA-256, commits, version). Mentions return type. However, lacks explicit statement that tool is read-only and does not modify anything. No annotations provided, so description carries full burden.

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?

Four sentences, front-loaded with main purpose. No redundant information. Every sentence adds value.

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 single parameter, no output schema, and no annotations, the description covers purpose, process, return type, and use case. Could mention error handling (e.g., missing lock file) but not essential.

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?

Single parameter 'filename' with 100% schema coverage. Description adds an example ('my_workflow.json') but no additional semantic meaning beyond the schema. Baseline 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?

Description specifies verb 'compare', resource 'saved workflow's lock file against current state', and outcome 'report drift'. Clearly distinguishes from sibling tools like lock_workflow and extract_workflow_dependencies.

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?

Provides explicit when-to-use: 'Use before re-running an important workflow days or weeks later to confirm it'll behave the same.' Also notes prerequisite 'Requires a local install (COMFYUI_PATH).' Does not specify when not to use, but context is clear.

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