Skip to main content
Glama

create_uib_data_broker

Creates a UI Builder transform data broker server script that returns records from a specified table, with query and field filters for page data.

Instructions

Create a UI Builder transform data broker (server script) that returns records from a table. Add it to a page in UI Builder; it needs a ux_data_broker execute ACL. [Scripting]

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>",
      "table": "<table>"
    },
    "name": "create_uib_data_broker"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesBroker name
pageNoTarget page sys_id (informational; brokers are added to pages in UI Builder)
queryNoEncoded query filter
tableYesSource table
fieldsNoComma-separated fields to return (default: sys_id + display value)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv5.0.1
    • addedInput schema / properties / fields
      Added value: +{
      +  "description": "Comma-separated fields to return (default: sys_id + display value)",
      +  "type": "string"
      +}
    • changedInput schema / properties / page / description
      Previous value: -"Target page sys_id"New value: +"Target page sys_id (informational; brokers are added to pages in UI Builder)"
  2. First observedv1.0.2

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare the mutation profile (readOnlyHint=false, destructiveHint=false, openWorldHint=true), so the bar is lower. The description still adds meaningful context beyond them: the output is a server script, an execute ACL is required, and page attachment happens outside this call. It does not say what the response contains or whether name must be unique.

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 action and object, followed by prerequisites. The trailing '**[Scripting]**' tag is low-value noise but the body has no wasted wording.

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?

Five params, all documented, and no output schema to explain, so the description is nearly adequate. It still leaves open what is returned on success (broker sys_id?), whether names must be unique, and how this relates to the existing list tool — gaps for a create operation.

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 baseline is 3. The description adds no parameter detail beyond the schema — even the 'page is informational' nuance already appears in the schema's own description for that property.

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 — 'Create a UI Builder transform data broker (server script)' — and explains what the artifact does ('returns records from a table'). That distinguishes it from the sibling list_uib_data_brokers, though it never names the read-side sibling explicitly.

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?

It provides a post-creation step ('Add it to a page in UI Builder') and a prerequisite ('needs a ux_data_broker execute ACL'), which is useful context. But it offers no explicit when-to-use versus alternatives guidance, e.g. checking list_uib_data_brokers first or choosing this over a component-based approach.

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