Skip to main content
Glama

modx_ms2_create_option

Create a miniShop2 product option with a key, caption, and type, and optionally assign category, measurement unit, and custom properties for product configuration.

Instructions

Create a miniShop2 product option in settings options.

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": {
      "key": "<key>",
      "caption": "<caption>",
      "type": "<type>"
    },
    "name": "modx_ms2_create_option"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyYes
typeYes
captionYes
categoryNo
propertiesNo
descriptionNo
category_idsNo
measure_unitNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

C2.2/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden, yet it says nothing about permissions needed, whether the 'key' must be unique, what happens on duplicate keys, or what is returned. For a mutation tool with zero annotation coverage this is a significant gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One short sentence is front-loaded and free of padding, so nothing is wasted. However, brevity here reflects under-specification rather than efficient communication.

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?

An 8-parameter creation tool with nested objects, no annotations, and no output schema needs far more guidance than this single sentence provides. An agent could not confidently populate required fields or predict the result from this definition.

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 0% across 8 parameters, including a nested 'properties' object, and the description explains none of them. It never clarifies the distinction between 'key', 'caption', 'type', 'category', or 'category_ids', so it adds no meaning beyond bare types.

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

Purpose3/5

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

The verb+resource pair ('Create a miniShop2 product option') is identifiable, but the trailing phrase 'in settings options' is ambiguous and adds confusion rather than scope. It does not distinguish this from siblings such as modx_ms2_assign_option_to_category or modx_ms2_update_option.

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 statement of when to use this versus alternatives like modx_ms2_update_option or modx_ms2_assign_option_to_category, and no prerequisites or preconditions are given. The agent must infer usage entirely from the name.

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