save_node_snapshot

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

With no annotations, the description carries full burden. It discloses two distinct behaviors (remote vs. local) and hints at file naming constraints, but lacks details on side effects like overwriting, file location, or required permissions. Adequate but not comprehensive.

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 sentences, no wasted words. Key information is front-loaded. Efficient and clear.

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 parameter count (1), absence of annotations, and no output schema, the description covers the tool's core function and two usage modes adequately. It could mention overwrite behavior or snapshot content, but overall is sufficient for an agent to use 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% for the single optional 'name' parameter. The description adds value by explaining the behavior difference when omitted (timestamped) vs. provided (custom file), and provides additional constraints (no extension, no path separators), going beyond the schema's basic description.

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 specifies the verb 'save' and resource 'snapshot' of ComfyUI custom-node and version state, clearly distinguishing it from sibling tools like 'restore_node_snapshot' and 'list_node_snapshots'. It also references the CLI command 'comfy node save-snapshot' for familiarity.

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?

Explicitly describes two usage scenarios: omit name for timestamped snapshot (works remotely) vs. provide name for custom-named file (local only). This gives clear guidance on when to use each mode, though it does not mention alternative tools like 'restore' or 'list' for related tasks.

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