get_uib_page

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

The annotations already declare readOnlyHint=true, so the agent knows this is a read-only operation. The description adds context about what the details include (layout and child elements), which goes beyond the annotations. It does not mention error handling or authentication, but for a simple get operation with readOnlyHint, this is sufficient.

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, concise sentence that front-loads the core action ('Get details') and includes relevant specifics without any waste or redundancy. It is appropriately sized for the tool's simplicity.

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 simple get-by-ID tool, the description is largely complete. It mentions what details are included (layout and child elements), and the schema covers the required parameter. No output schema exists, but the description hints at the return value. As noted, it does not address error cases or what happens if the page is not found, but those are not critical for this simple tool.

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 schema description covers 100% of the single parameter, stating 'UIB page sys_id'. The description does not add any additional parameter semantics beyond what the schema already provides, so the 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 'Get details of a specific UI Builder page' with a specific verb ('Get'), resource ('UI Builder page'), and scope ('specific'). It also mentions the returned content ('including layout and child elements'), which adds clarity. This distinguishes it from sibling tools like list_uib_pages, create_uib_page, update_uib_page, and delete_uib_page.

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 by saying 'specific UI Builder page', but does not explicitly state when to use this tool vs list_uib_pages or provide any exclusions. There is no guidance on alternatives or when this tool is preferred, leaving the agent to infer from the name and description.

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