Skip to main content
Glama

modx_ms2_get_product_options

Retrieve miniShop2 option values for a product by its ID to inspect or use its configured product options in MODX.

Instructions

Read miniShop2 option values assigned to a product.

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>"
    },
    "name": "modx_ms2_get_product_options"
  }
}

Input Schema

NameRequiredDescriptionDefault
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?

No annotations are supplied, so the description carries the full burden. 'Read' implies a safe read, but it says nothing about inherited category-level option values vs product-level overrides, pagination, or what the response contains for a product with no options.

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?

A single front-loaded sentence with no filler or redundancy. It is efficient, though its brevity borders on under-specification rather than tight writing.

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?

The tool is simple (one param, no output schema, no annotations), so the bar is low, but the description never clarifies the return shape or the inheritance semantics that matter for interpreting miniShop2 product options. Adequate to invoke, thin for interpretation.

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?

One required parameter with 0% schema description coverage; the description adds no meaning beyond restating 'a product'. The name product_id is largely self-explanatory, but it isn't clarified whether this is a MODX resource ID or a miniShop2 product record ID.

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 (read miniShop2 option values assigned to a product). The phrase 'assigned to a product' implicitly distinguishes it from modx_ms2_list_options (global option definitions) and modx_ms2_update_product_options (the write counterpart), but it never names those siblings explicitly.

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?

No when-to-use or when-not-to-use guidance. It doesn't tell the agent to prefer modx_ms2_get_option when it wants a single option's definition, nor does it mention that a related write tool exists for changing these values.

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