update_uib_component

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

Annotations indicate non-readonly, non-destructive, idempotent, and open-world behavior. The description adds only the ambiguous note '[Scripting]', which provides minimal additional context about behavioral traits like permission requirements or side effects.

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 concise with one sentence and a bracketed note, but it lacks structure and important details. It is front-loaded but overly minimal, missing opportunities to provide essential context.

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?

Given the tool's 3 parameters, no output schema, and many sibling tools, the description is severely incomplete. It does not explain return values, permissions, examples, or how it interacts with other UI Builder components.

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?

The input schema has 3 parameters with only 33% description coverage (only 'sys_id' has a description). The description does not explain the semantics of 'label' or 'description' in the context of a UI Builder component, adding no value beyond the schema.

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 verb 'Update' and the resource 'UI Builder component', distinguishing it from sibling update tools for other resources like 'update_uib_page'. However, it does not elaborate on the scope or effect of the update.

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?

There is no guidance on when to use this tool versus alternatives such as 'create_uib_component' or other update tools. The description does not mention prerequisites, context, or when not to use the tool.

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