Skip to main content
Glama

create_ux_app_route

Registers a new URL route in a ServiceNow UX app and links it to a target page so users can navigate to that screen via a defined path.

Instructions

Register a new route (URL path) in a UX app. [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": {
      "app_sys_id": "<app_sys_id>",
      "path": "<path>",
      "page_sys_id": "<page_sys_id>"
    },
    "name": "create_ux_app_route"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesRoute path
titleNoRoute title
app_sys_idYesUX app config (sys_ux_app_config) or experience (sys_ux_page_registry) sys_id
page_sys_idYesTarget UIB page (screen collection) sys_id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv5.0.1
    • changedInput schema / properties / app_sys_id / description
      Previous value: -"UX app sys_id"New value: +"UX app config (sys_ux_app_config) or experience (sys_ux_page_registry) sys_id"
    • changedInput schema / properties / page_sys_id / description
      Previous value: -"Target UIB page sys_id"New value: +"Target UIB page (screen collection) sys_id"
  2. First observedv1.0.2

TDQS

C2.9/5.0
Behavior2/5

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

The "[Write]" tag merely restates the annotation readOnlyHint=false, adding nothing beyond structured data. Nothing is said about duplicate-path behavior, whether registration is reversible, what permissions are required, or whether the route is immediately live, despite openWorldHint=true and idempotentHint=false making those questions relevant.

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?

One short, front-loaded sentence with the resource and scope stated immediately. The trailing "[Write]" marker is redundant with the annotations, the only wasted element in 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?

For a four-parameter create tool with full schema coverage and annotations covering the safety profile, this is minimally adequate. But it omits what happens on success or on a conflicting path, and gives no hint that the referenced app and page must pre-exist, which are the main failure modes an agent needs to avoid.

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 all four parameters are already documented in the schema, establishing a baseline of 3. The description only loosely restates that path is a URL path and the parent is a UX app; it adds no syntax, uniqueness, or format constraints beyond the schema.

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 plus resource ("Register a new route (URL path) in a UX app"), which is unambiguous and distinguishes it from the read/list siblings like get_ux_app and list_ux_apps. It does not, however, contrast itself with the other create_* siblings such as create_ux_experience, so sibling differentiation is only partial.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no prerequisites (e.g. that the target UX app and page must already exist), and no mention of alternatives. An agent must infer from the name and required parameters alone that this belongs after app/page creation.

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