Skip to main content
Glama

create_workspace

Creates a configurable ServiceNow workspace configuration with a primary table and default list, enabling Workspace Builder users to define workspace structure and navigation.

Instructions

Create a new configurable workspace config (sys_aw_master_config) with a default list for its primary table. The UI Builder experience itself is generated in Workspace 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": {
      "name": "<name>",
      "table": "<table>"
    },
    "name": "create_workspace"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNoWorkspace URL path segment (default: derived from name)
iconNoWorkspace icon name (not stored on the workspace config; kept for compatibility)
nameYesWorkspace name
tableYesPrimary table (e.g. incident); a default list for it is added
columnsNoColumns for the default list (default number,short_description,state,sys_updated_on)
descriptionNo
navigation_typeNotab (default) or breadcrumb

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv5.0.1
    • addedInput schema / properties / columns
      Added value: +{
      +  "description": "Columns for the default list (default number,short_description,state,sys_updated_on)",
      +  "type": "string"
      +}
    • changedInput schema / properties / icon / description
      Previous value: -"Workspace icon name"New value: +"Workspace icon name (not stored on the workspace config; kept for compatibility)"
    • addedInput schema / properties / navigation_type
      Added value: +{
      +  "description": "tab (default) or breadcrumb",
      +  "type": "string"
      +}
    • changedInput schema / properties / table / description
      Previous value: -"Primary table (e.g. incident)"New value: +"Primary table (e.g. incident); a default list for it is added"
    • addedInput schema / properties / url
      Added value: +{
      +  "description": "Workspace URL path segment (default: derived from name)",
      +  "type": "string"
      +}
  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=false, destructiveHint=false, openWorldHint=true and idempotentHint=false, and the '[Write]' tag merely restates that. The description does add one genuinely behavioral fact beyond annotations: a default list with default columns is created alongside the config, which is a real side effect an agent should anticipate. It says nothing about permissions, failure modes, or non-idempotency consequences, so it remains partial.

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 short sentences, front-loaded with the core action, followed by the scope caveat. The '[Write]' marker is redundant with readOnlyHint=false and adds no information, which keeps it from a 5.

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 create tool with no output schema, the description never indicates what comes back (for example the created config's identifier), which an agent needs to chain into follow-up calls like configure_workspace_list. Permissions and validation expectations are also unstated. Annotations cover the safety profile, so this is a moderate gap rather than a fatal one.

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 86%, so the schema already documents almost every parameter including defaults for url, columns and navigation_type. The description adds little beyond repeating that a default list for the primary table is added, which the 'table' parameter description already states. Baseline 3 is appropriate where the schema carries the parameter burden.

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 configurable workspace config (sys_aw_master_config)') and even names the underlying table, so the agent knows exactly what is produced. It also draws a scope boundary by noting the UI Builder experience is generated elsewhere, which separates it from UI-generation work. It stops short of naming a concrete sibling alternative such as configure_workspace_list, so it is not a 5.

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: an agent can infer this is the entry point for creating a workspace, and the Workspace Builder sentence hints that UI assembly is a separate step. There is no explicit 'use this when X, use Y instead' guidance and no stated prerequisites, so the routing burden remains on the agent.

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