ui_add_control

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

No annotations are provided, so the description must carry the full burden. It only states that the tool adds a node and returns a success/error message. It fails to disclose side effects (e.g., file modification), prerequisites (e.g., scene must be open), or error conditions.

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?

The description is structured as a typical docstring with a one-line summary, category, args, and returns. It is reasonably concise, though the 'Category: UI' line is redundant. The action is front-loaded.

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?

The description covers all parameters and return value but lacks context on prerequisites (e.g., scene must be loaded), error scenarios, or a comprehensive list of valid control types. It is adequate but not thorough for a 6-parameter tool with no annotations.

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 0%, but the description provides explanations for all 6 parameters, adding meaning beyond the schema. For example, 'control_type: Type of control (Button, Label, Panel, LineEdit, TextureRect, etc.)' and 'text: Text content for controls that support it'. This compensates for missing schema descriptions.

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 'Add a UI control node to a scene', specifying the verb (Add), resource (UI control node), and context (scene). It also lists example control types, distinguishing it from siblings like ui_add_container.

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?

No explicit guidance on when to use this tool vs alternatives. The description implies usage by listing control types but does not contrast with sibling tools (e.g., ui_add_container for containers).

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