restore_node_snapshot

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

With no annotations, the description carries the full burden. It discloses the key behavioral trait that ComfyUI-Manager applies changes on the next restart, alerting the agent that effects are not immediate. This is useful but could mention further details like overwriting or potential conflicts.

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: first states the core action and tool, second provides a usage hint. Every word is purposeful, and the essential information is front-loaded. No redundancy or fluff.

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 simple one-param tool with no output schema or annotations, the description adequately covers purpose, prerequisite, and behavioral effect. It could optionally mention if the snapshot is stored locally or requires permissions, but it is sufficiently complete for effective use.

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% with the 'name' parameter described as 'Name of the snapshot to restore (as shown by list_node_snapshots).' The tool description echoes this same information without adding new meaning, so it meets the baseline but does not exceed it.

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 action 'Restore a previously saved custom-node snapshot' and references the underlying tool 'ComfyUI-Manager'. The verb 'restore' and the resource 'snapshot' are specific, and it distinguishes from siblings like 'list_node_snapshots' and 'save_node_snapshot' by referencing them.

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 includes explicit guidance to use 'list_node_snapshots' to find snapshot names, which is a critical prerequisite. It also implies that changes take effect on next restart, providing context for when to expect results, though it does not state when not to use the tool or list alternatives.

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