Skip to main content
Glama

modx_ms2_create_category

Creates a miniShop2 category as an msCategory resource under a chosen parent, with optional alias and publish status.

Instructions

Create a miniShop2 category (msCategory resource).

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": {
      "pagetitle": "<pagetitle>",
      "parent": "<parent>"
    },
    "name": "modx_ms2_create_category"
  }
}

Input Schema

NameRequiredDescriptionDefault
aliasNo
parentYesParent resource/category id.
pagetitleYes
publishedNo

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 behavioral burden. It conveys only that a write/mutation happens; it says nothing about required permissions, whether an alias is auto-generated from the pagetitle, what the default published state is, whether URIs get regenerated, or what identifier is returned.

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 terse rather than padded, and its brevity costs it detail, but as structure goes it is clean and immediately scannable.

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 creation tool with four parameters, two of them required, no annotations and no output schema, the description is too thin: an agent cannot tell what defaults apply, what happens on duplicate alias, or what the call returns. The designation of the created type is the only substantive detail provided.

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 description coverage is only 25% (just 'parent'), so the description should compensate but does not discuss any parameters. However, the phrase 'msCategory resource' weakly signals that pagetitle/alias/published are standard MODX resource fields, giving some transferable meaning; the undocumented alias and published parameters remain ambiguous.

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 ('Create a miniShop2 category') and clarifies the underlying type ('msCategory resource'), which is meaningful domain context. It is distinguishable from modx_ms2_list_categories and modx_ms2_update_category by the create verb, though the description does not explicitly acknowledge those siblings.

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 about prerequisites (e.g. that the parent must exist or be a valid container), no mention of when to use this versus modx_create_element or modx_ms2_update_category, and no exclusions. The agent must infer everything from the tool 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