Skip to main content
Glama

update_catalog_item

Idempotent

Update an existing catalog item (requires WRITE_ENABLED=true)

Instructions

Update an existing catalog item (requires WRITE_ENABLED=true)

Input Schema

NameRequiredDescriptionDefault
fieldsYesFields to update (name, short_description, price, active, category, etc.)
sys_idYesCatalog item sys_id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.15.1
    • addedInput schema / properties / fields / additionalProperties
      Added value: +false
    • addedInput schema / properties / fields / properties
      Added value: +{
      +  "active": {},
      +  "category": {},
      +  "delivery_time": {},
      +  "description": {},
      +  "name": {},
      +  "price": {},
      +  "roles": {},
      +  "short_description": {}
      +}
  2. First observedv1.0.2

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnly=false, idempotent=true, destructive=false, so the safety profile is largely covered. The description adds real value with the WRITE_ENABLED=true precondition, but says nothing about partial-update semantics, whether omitted fields are preserved, or what happens to fields not in the allowed set.

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 sentence with the core action front-loaded and the prerequisite parenthesized. It earns its place but is so terse that the parenthetical constraint reads as an afterthought rather than structured guidance.

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 mutation tool whose required 'fields' parameter is a nested object with additionalProperties=false, an agent needs to know whether this is a partial patch or a replace, and how unknown/invalid field names are handled. Neither is addressed, and there is no output schema to fall back on.

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 coverage is 100% and the nested fields object already enumerates name, price, roles, active, category, description, delivery_time and short_description. The description adds nothing beyond the schema, which is the baseline 3 case.

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?

States a specific verb and resource ("Update an existing catalog item"), so an agent can distinguish it from create_catalog_item and get_catalog_item in the sibling list. It does not, however, explicitly call out that distinction or what an 'item' contains.

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?

The only usage context is the prerequisite WRITE_ENABLED=true. There is no guidance on when to use this versus create_catalog_item, order_catalog_item, or create_catalog_variable, and no indication of what cannot be updated.

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