Skip to main content
Glama

get_uib_page

Read-only

Retrieve details for a specific UI Builder page (screen collection), including its routes and screen variants, by providing the page sys_id.

Instructions

Get details of a specific UI Builder page (screen collection) including its routes and screen variants

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "sys_id": "<sys_id>"
    },
    "name": "get_uib_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
sys_idYesUIB page sys_id (screen collection, sys_ux_screen_type)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.0.1
    • changedInput schema / properties / sys_id / description
      Previous value: -"UIB page sys_id"New value: +"UIB page sys_id (screen collection, sys_ux_screen_type)"
  2. First observedv1.0.2

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds that the response includes routes and screen variants, which is genuinely useful return-shape context given there is no output schema, but it omits behavior on invalid/unknown sys_id and any scoping or permission constraints.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One tightly written sentence with the resource and the returned contents front-loaded, and no filler or redundant restatement of the tool name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter read tool with full schema coverage and annotations covering the safety profile, the description supplies the one thing structured data does not: what the response contains. It could still note failure behavior for a bad sys_id, which keeps it from a 5.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the single sys_id parameter is already fully documented, including the 'screen collection, sys_ux_screen_type' disambiguation. The description adds nothing about the identifier beyond what the schema states, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Get) and resource (a specific UI Builder page / screen collection) and names the payload contents (routes and screen variants), which clearly separates it from list_uib_pages. It never explicitly names the sibling it replaces, so it stops short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The word "specific" plus the required sys_id implies this is the lookup-by-identifier tool as opposed to a listing tool, and the sibling set (list_uib_pages, get_portal_page) makes that inference easy. However, the description never says when to use this instead of list_uib_pages or get_portal_page, nor any prerequisites such as needing a valid sys_id.

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

Deploy Server

Other Tools