sync_nodes_to_knowledge

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

With no annotations, the description carries the full burden and does substantial work: it discloses that the operation is additive-only (skips existing entries, so no overwrite/removal risk), that it creates a knowledge/ directory as a side effect, and that a running ComfyUI instance is required. It stops short of saying whether the operation is idempotent under partial failure or what filesystem permissions are needed.

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?

Three dense sentences, front-loaded with the core action and each sentence contributing a distinct fact (behavior, destination, prerequisite). The parenthetical env-var aside slightly interrupts the flow but does not waste space.

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 zero-parameter mutation tool with no output schema and no annotations, the description covers purpose, additive semantics, directory creation, and the runtime prerequisite. The main remaining gap is what the call reports back (e.g. how many nodes were added), which matters for verifying success.

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?

Zero parameters means the baseline is 4. The description adds a valuable non-schema input — the COMFYUI_KNOWLEDGE_DIR environment variable that controls the destination directory — information the empty schema cannot convey.

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?

States a specific verb+resource+scope: sync node definitions from a running ComfyUI into the knowledge base, with the additive behavior spelled out ('adds only nodes that are not already in base-nodes.json'). It is distinguishable from read-only siblings like list_node_types or discover_nodes_live, though it never names an alternative tool.

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?

Gives a hard prerequisite ('Requires ComfyUI to be running') and a configuration hint (COMFYUI_KNOWLEDGE_DIR), which implies when the tool is usable. However it never states the situational trigger (e.g. after installing custom nodes) or contrasts with discover_nodes_live / list_node_types, leaving the agent to infer when this is the right call over siblings.

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