ms_sync_from_engine

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

With no annotations, the description carries the full behavioral burden and does reasonably well: it discloses the side effects (updates the in-memory METASOUND_NODES dict and optionally upserts into the SQLite DB) and the delegation to an engine command. It does not state the engine-connection requirement, whether existing entries are overwritten/lost, or any failure mode.

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?

Front-loaded with the core action in the first line, then a short mechanism sentence, then Args/Returns. The Returns block is somewhat redundant given an output schema exists, but the overall structure is clean and each section is brief.

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 sync tool with three optional params and an output schema present, the description covers purpose, mechanism, side effects, and parameter meaning adequately. It omits the engine-connection prerequisite and the overwrite semantics of the sync, which are the main remaining gaps.

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 description coverage is 0%, so the description must compensate, and it does: update_db is explained as an optional SQLite upsert, filter as a substring filter on node class names, and limit as the max nodes to fetch with its 5000 default. All three parameters gain meaning beyond the bare schema types.

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 and resource ('Sync MetaSounds node catalogue from the running UE5 engine') and explains the mechanism (calls list_metasound_nodes against the engine registry, refreshes the in-memory METASOUND_NODES dict). This clearly distinguishes it from read-only siblings like ms_list_nodes/ms_search_nodes and from the analogous bp_sync_from_engine.

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 implies usage (refreshing the local catalogue from the engine) but never states when an agent should call this versus ms_list_nodes, ms_node_info, or bp_sync_from_engine. No prerequisites (e.g. an active ue5_connect session) or exclusions are given, so the agent must infer context.

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