Skip to main content
Glama

modx_ms2_update_product_options

Create, update, or remove miniShop2 product option values with a single call; set an option value to null to delete it.

Instructions

Create, update, or remove miniShop2 option values for a product. Use null value to remove an option value.

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": {
      "product_id": "<product_id>",
      "options": "<options>"
    },
    "name": "modx_ms2_update_product_options"
  }
}

Input Schema

NameRequiredDescriptionDefault
optionsYes
product_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden for a mutation tool. It discloses the null-deletion convention but says nothing about whether the supplied options object merges with or replaces existing option values, what permissions are required, or that removals are destructive/irreversible.

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 action and followed by the one non-obvious rule. No filler, though the brevity leaves the merge/replace question unaddressed.

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 on a nested anyOf-valued object with no annotations and no output schema, the definition is too thin. An agent cannot determine replace-vs-merge semantics or the shape of the options payload from this description alone.

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

Parameters2/5

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

Schema description coverage is 0% for a nested object parameter, and the description only explains the null value case. It never says the options object keys are option names, that values may be scalars or string arrays, or what product_id identifies beyond its name.

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 set (create/update/remove) and resource (miniShop2 option values for a product), which is clearly distinct from read-side siblings like modx_ms2_get_product_options or modx_ms2_list_options. It stops short of explicitly naming those siblings as alternatives, so it is clear but not fully differentiated.

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?

The one piece of usage guidance given is the null-to-remove convention, which is genuinely useful. There is no guidance on when to use this versus modx_ms2_assign_option_to_category, modx_ms2_update_option, or how it differs from editing product options elsewhere in the ms2 family.

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