Skip to main content
Glama
Sign In
MODX MCP

MODX MCP

by rumata-estor
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

modx_list_user_groups

Lists MODX user groups with ID, name, parent, and rank, with optional name filtering and pagination via limit and start.

Instructions

List MODX user groups (id, name, parent, rank).

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_list_user_groups"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
queryNoFilter by name.
startNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

C2.8/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. "List" implies a read operation and the parenthetical hints at the row shape, but there is no statement about pagination behavior (limit/start), default result size, ordering, or permissions required to enumerate groups.

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?

One short sentence with the resource named first and the returned fields appended in parentheses; no wasted words. Its brevity is efficient rather than padding, though the parenthetical could have been spent on pagination instead.

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?

For a simple read-only list tool with three optional parameters and no output schema, naming the returned fields is genuinely useful. However, the undocumented limit/start pagination and absent filtering behavior leave an agent guessing on how to page through large group sets.

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 only 33% — 'query' is documented in the schema but 'limit' and 'start' are bare numbers. The description never explains pagination, defaults, or maximum values, so it fails to compensate for the coverage gap on two of three parameters.

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?

The description gives a specific verb and resource ("List MODX user groups") and enumerates the fields returned (id, name, parent, rank), which clearly separates it from get_user_group or the member-management siblings. It stops short of explicitly naming which sibling to use for a single group lookup or for membership listing.

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 at all: nothing indicates when to call this versus modx_get_user_group for one group or modx_list_user_group_members for membership. The 'query' filter is the only implicit hint, and it is not framed as a decision 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