Skip to main content
Glama

list_uib_pages

Read-only

Retrieve UI Builder pages and their route configurations, including app routes with screen collections. Filter by UX app config or experience to inspect page structure.

Instructions

List UI Builder pages (app routes with their screen collections) and their route configurations

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_uib_pages"
  }
}

Input Schema

NameRequiredDescriptionDefault
appNoFilter by UX app config (sys_ux_app_config) or experience (sys_ux_page_registry) sys_id
limitNoMax records (default 25)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.0.1
    • changedInput schema / properties / app / description
      Previous value: -"Filter by UX app sys_id"New value: +"Filter by UX app config (sys_ux_app_config) or experience (sys_ux_page_registry) sys_id"
  2. First observedv1.0.2

TDQS

B3.4/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 real value by disclosing that returned routes carry their screen collections and route configurations, but it says nothing about total counts, pagination beyond the limit param, or whether filtering by app narrows to app config vs experience.

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

Conciseness4/5

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

A single front-loaded sentence with no filler; the parenthetical carries useful clarification rather than padding. It is efficiently sized for a simple two-parameter list tool.

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

Completeness3/5

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

For a simple read-only lister with two fully documented optional params and no output schema, the definition covers purpose and rough return content. It lacks guidance on pagination behavior/default result size and on how to pick among the several sibling page-listing tools, leaving gaps an agent must resolve by trial.

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%, with both 'app' (sys_ux_app_config or sys_ux_page_registry sys_id) and 'limit' fully documented in the schema. The description adds no parameter semantics beyond that, 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?

The description gives a specific verb and resource ("List UI Builder pages") and clarifies what a page actually is ("app routes with their screen collections") plus route configurations, so the agent knows the payload domain. It stops short of naming how it differs from adjacent listers like list_ux_pages or list_portal_pages, so it is clear but not sibling-differentiated.

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?

Usage is only implied by the verb "List" and the optional app filter; there is no explicit statement of when to choose this over list_ux_pages, list_portal_pages, or get_uib_page for a single page. An agent can infer this is the collection-level read for UI Builder pages, but nothing is stated.

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