Skip to main content
Glama
TaiRaven
by TaiRaven

update_catalog_item_variable

Update an existing ServiceNow catalog item variable by providing its sys_id and modifying fields like label, description, default value, or mandatory status.

Instructions

Update an existing catalog item variable.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
maxNo
minNo
labelNo
orderNo
help_textNo
mandatoryNo
max_lengthNo
descriptionNo
variable_idYessys_id of the variable to update
default_valueNo
reference_qualifierNo
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It does not mention side effects, idempotency, permissions, error conditions, or return values. The single statement is purely functional with no added context.

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?

The description is one short sentence with no fluff. It is appropriately concise and front-loaded with the core action. However, it might be too minimal, but conciseness alone is well achieved.

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?

Given the tool has 11 parameters and no output schema, the description is grossly incomplete. It does not explain required vs optional fields (beyond schema), update semantics, or relationships to other catalog components. An agent would have insufficient information to call it correctly beyond a guess.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 9% (only variable_id has a description). The tool description adds zero explanation for the other 10 parameters. It does not compensate for the low coverage; no parameter semantics beyond the bare names are provided.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific verb ('Update') and a specific resource ('existing catalog item variable'), which distinguishes it from sibling tools like create_catalog_item_variable and list_catalog_item_variables. No ambiguity about the primary action.

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 use this tool versus alternatives like create_catalog_item_variable. It simply states what it does without context on selection criteria, prerequisites, or when updating is appropriate over creating.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/TaiRaven/sn-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server