Skip to main content
Glama

create_uib_page

Creates a new UI Builder page screen collection and, when an app is provided, registers its route so you can build the page content in UI Builder.

Instructions

Create a new UI Builder page: a screen collection (sys_ux_screen_type) plus, when app is given, its route (sys_ux_app_route). Build the page content in UI Builder. [Write]

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": {
      "title": "<title>",
      "path": "<path>"
    },
    "name": "create_uib_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
appNoUX app config (sys_ux_app_config) or experience (sys_ux_page_registry) sys_id to register the route in
pathYesURL path segment (route)
titleYesPage title
layoutNoLayout type (informational; layout is set in UI Builder)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv5.0.1
    • changedInput schema / properties / app / description
      Previous value: -"Parent UX app sys_id"New value: +"UX app config (sys_ux_app_config) or experience (sys_ux_page_registry) sys_id to register the route in"
    • changedInput schema / properties / layout / description
      Previous value: -"Layout type: single, sidebar, tabbed (default single)"New value: +"Layout type (informational; layout is set in UI Builder)"
    • changedInput schema / properties / path / description
      Previous value: -"URL path segment"New value: +"URL path segment (route)"
  2. First observedv1.0.2

TDQS

A3.8/5.0
Behavior4/5

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

The description adds real behavioral detail beyond annotations by disclosing exactly which backend records are written (screen collection plus route) and that route creation is conditional on the app parameter. The "**[Write]**" marker merely restates readOnlyHint=false and adds no value. Since annotations already cover safety profile, this is a solid rather than exceptional addition.

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?

Two sentences, front-loaded with the primary action and the side effect. The redundant "[Write]" tag and the somewhat parenthetical record-type names slightly clutter an otherwise efficient definition.

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?

There is no output schema, and the description never indicates what is returned (e.g., sys_ids of the created page/route), which an agent needs to chain further calls. It does cover the write behavior and the optional-route side effect, so the core is complete but the return contract is missing.

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 coverage is 100%, so all four parameters are already documented, and the schema itself explains that app is the sys_id to register the route in. The description's only added meaning is that app conditionally triggers route creation, which is marginal. Baseline 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 uses a specific verb and resource ("Create a new UI Builder page") and names the concrete records produced (sys_ux_screen_type screen collection and, conditionally, sys_ux_app_route). This clearly distinguishes it from get/update/delete_uib_page and from create_uib_component, though it never explicitly contrasts itself with create_portal_page.

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

Usage Guidelines4/5

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

"Build the page content in UI Builder" establishes a scope boundary: this tool creates the page shell and optional route, not its content. The conditional "when app is given" also tells the agent how to control whether a route is registered. No explicit when-not guidance or named alternative is given.

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