xae_tree_consume_xml

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

Annotations already declare readOnlyHint=false, destructiveHint=false and idempotentHint=true, so the safety profile is covered. The description adds real value by enumerating the kinds of mutations this path performs, but it says nothing about failure behavior, partial application, or why a generic XML write is idempotent when it 'adds' elements.

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?

One sentence, front-loaded with the core action and then justified by concrete examples. The parenthetical list is long but every item earns its place by clarifying the breadth of 'any configuration'.

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?

An output schema exists so return values need not be described. But for a generic XML write against an engineering tree, the accepted XML dialect/format is the single most important thing an agent must know, and the description never addresses it even though schema coverage is 0%.

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 carries the full burden, yet it documents neither parameter. 'On a tree item' loosely implies path is a tree node, and 'ConsumeXml' loosely implies xml is the configuration payload, but no format, encoding, or dialect for the XML is given.

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 pair ('ConsumeXml on a tree item') and quantifies the scope as 'the generic write path for any configuration', which separates it from narrower siblings like xae_tree_set_values and xae_tree_create_child. It stops short of explicitly naming those siblings as alternatives.

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 parenthetical examples (I/O boxes, variable links, task cycle time, TIRR routes) give a good feel for when this tool applies, and 'any configuration' signals broad applicability. However, it never says when NOT to use it or when the targeted siblings (xae_tree_set_values, xae_tree_create_child, xae_links) would be preferable, which an agent needs before defaulting to a generic write.

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