Skip to main content
Glama

create_catalog_variable

Add a form variable to a ServiceNow catalog item by specifying its name, question text, type, order, and mandatory status.

Instructions

[Write] Add a form variable to a service catalog item

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": {
      "cat_item_id": "<cat_item_id>",
      "name": "<name>",
      "question_text": "<question_text>",
      "type": "<type>"
    },
    "name": "create_catalog_variable"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesVariable name
typeYesVariable type: string/reference/select_box/checkbox/date/date_time/integer (single line text)/multi_line_text/email/yes_no/multiple_choice/numeric_scale/list_collector/url/label, or a raw type number
orderNoDisplay order (default: 100)
mandatoryNoRequired field
cat_item_idYesCatalog item sys_id
question_textYesLabel shown to user

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.0.1
    • changedInput schema / properties / type / description
      Previous value: -"Variable type: string/reference/select_box/checkbox/date/date_time/integer/multi_line_text/email"New value: +"Variable type: string/reference/select_box/checkbox/date/date_time/integer (single line text)/multi_line_text/email/yes_no/multiple_choice/numeric_scale/list_collector/url/label, or a raw type number"
  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 declare readOnlyHint=false, openWorldHint=true, idempotentHint=false and destructiveHint=false, so the safety profile is covered externally. The description adds nothing beyond that - no statement about permission requirements, uniqueness constraints on variable names, or effects on the catalog item's form layout. For a write operation it is essentially a restatement of the title.

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 no filler; the write marker leads a reader straight to the point. It is arguably under-specified rather than padded, which is a completeness rather than conciseness issue.

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?

Because the schema fully documents all six parameters and annotations cover the mutation profile, the definition is minimally sufficient to invoke the tool. It nevertheless omits practical context - whether the parent catalog item must exist, whether variable names must be unique, and what is returned - which matters for a create tool with no output schema.

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 six parameters carrying its own description including the enumerated type list and the order default of 100. The description contributes no additional semantics, so the 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 verb-plus-resource phrasing 'Add a form variable to a service catalog item' names the action, the created entity, and its parent object, which separates it from create_catalog_item or create_catalog_category. It stops short of explicitly naming which sibling to use when the intent is ambiguous.

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 prerequisite (e.g. that cat_item_id must reference an existing catalog item), and no mention of alternatives such as update_catalog_item. The only hint is the '[Write]' prefix, which merely restates the mutation nature already given by annotations.

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