Skip to main content
Glama

create_ux_experience

Create a new UX Experience app shell configuration by defining its name, parent application, URL path, and landing page for a ServiceNow portal experience.

Instructions

Create a new UX Experience (app shell) configuration. [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": {
      "name": "<name>",
      "app_sys_id": "<app_sys_id>"
    },
    "name": "create_ux_experience"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesExperience name
pathNoExperience URL path (default: derived from name)
app_sys_idYesUX parent application (sys_ux_app) sys_id
landing_pageNoLanding route path (default home)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv5.0.1
    • changedInput schema / properties / app_sys_id / description
      Previous value: -"UX app sys_id"New value: +"UX parent application (sys_ux_app) sys_id"
    • changedInput schema / properties / landing_page / description
      Previous value: -"Landing page sys_id"New value: +"Landing route path (default home)"
    • addedInput schema / properties / path
      Added value: +{
      +  "description": "Experience URL path (default: derived from name)",
      +  "type": "string"
      +}
  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?

Annotations already state it is a non-read-only, non-idempotent, open-world write, so the "**[Write]**" tag merely repeats structured data. Beyond that the description says nothing about whether names or paths must be unique, what happens on collision with an existing experience, or what the call returns.

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 bold "[Write]" marker is the only redundant element, since annotations already declare the write semantics.

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

Completeness2/5

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

For a create tool with no output schema, the description should say what is returned (e.g. the new experience record or its sys_id) and what can go wrong. Neither is covered, and it is silent on the parent-application requirement that the schema only implies.

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 each of the four parameters documented including defaults for path and landing_page, so the baseline is 3. The description adds no extra meaning about expected formats or constraints on those values.

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?

"Create a new UX Experience (app shell) configuration" gives a specific verb and resource, and the "(app shell)" gloss separates it from sibling create_ux_app_route and the list_* readers. It stops short of naming an alternative outright, but an agent can tell what object is being created.

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 guidance on when to choose this over create_ux_app_route or the other creation tools, no stated prerequisites (e.g. an existing sys_ux_app), and no note on failure conditions. The only hint at a prerequisite is buried in the app_sys_id parameter description.

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