create_uib_data_broker

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

Annotations indicate mutating (readOnlyHint=false) and non-destructive (destructiveHint=false), but the description adds only the vague '[Scripting]' tag, which hints at required permissions but does not explain it. No details on side effects, error scenarios, or limitations beyond what annotations provide.

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 a single sentence with a functional tag. It is front-loaded with the primary purpose and contains no unnecessary words or repetition. Every part earns its place.

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 creation tool with four parameters and no output schema, the description adequately states the outcome but omits important context like response format (e.g., the sys_id of the created broker), required permissions beyond the '[Scripting]' hint, or error conditions. It is minimally complete but lacks depth.

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 already describes all four parameters with names and descriptions. The description adds no extra meaning or usage examples for the parameters (e.g., how 'query' should be formatted or what 'page' expects). With 100% schema coverage, a baseline of 3 is appropriate.

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 action ('Create') and the resource ('UI Builder data broker') with a specific purpose ('to feed data to a page'). This distinguishes it from sibling creation tools like create_uib_component or create_uib_page, which target different UI Builder entities.

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 guidance is provided on when to use this tool versus alternatives (e.g., list_uib_data_brokers for retrieval, or other create tools). There are no prerequisites, context boundaries, or exclusions mentioned, leaving the agent to infer usage from the tool name alone.

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