Skip to main content
Glama

modx_ms2_list_options

Retrieve and filter miniShop2 product options from the settings options tab by query, category, or modcategory, with an optional result limit.

Instructions

List miniShop2 product options from the settings options tab.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "modx_ms2_list_options"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
queryNo
categoryNo
modcategoryNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

C2.6/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 pagination, default limit, sort order, or what a returned option record contains. The only behavioral clue is the source tab reference, which implies these are global option definitions rather than per-product assignments — useful but thin for a zero-annotation tool.

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 short sentence, front-loaded with the verb and resource, with no filler. Its brevity is efficient rather than padded, though the space saved is not spent on any of the missing parameter or behavior detail.

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?

A four-parameter list tool with no annotations, no output schema, and no documented parameter meanings needs considerably more description than one sentence. The agent cannot tell what query matches against, what category filters on, or whether results are paginated.

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?

All four parameters (limit, query, category, modcategory) have 0% schema description coverage and the description adds no meaning for any of them. In particular the category vs. modcategory distinction is completely opaque and must be guessed.

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 (List) and a specific resource (miniShop2 product options) plus the source location (settings options tab), so an agent knows this is a read of the global option definitions. It does not explicitly distinguish itself from modx_ms2_list_option_types or modx_ms2_get_product_options, which read similarly-named things, so it falls short of a 5.

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 when-to-use guidance, no statement of when not to use it, and no mention of the close siblings (get_option, list_option_types, get_product_options) that an agent must choose between. The phrase 'from the settings options tab' hints at scope but gives no routing rule.

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