Skip to main content
Glama

modx_update_role

Update an existing MODX user role by ID, changing its name or authority level to keep permissions and access assignments accurate.

Instructions

Update a role.

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": {
      "id": "<id>"
    },
    "name": "modx_update_role"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
nameNo
authorityNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

D1.3/5.0
Behavior1/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 of behavioral disclosure. It says nothing about required permissions, whether omitted fields are preserved or cleared, whether the change is reversible, or what a successful response contains — significant gaps for a mutation tool.

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

Conciseness2/5

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

It is short and front-loaded, but the brevity comes from under-specification rather than economy. Every sentence that should earn its place — what to pass, what gets changed — is absent.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with zero annotation coverage, no output schema, and undocumented parameters, the description omits everything an agent needs to call it correctly. It is nowhere near complete for this complexity.

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 three parameters, so the schema documents nothing beyond types. The description does not mention id, name, or authority, leaving the agent with no idea which fields are editable, what authority controls, or whether this is a full or partial update.

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

Purpose2/5

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

"Update a role" restates the tool name with no additional specificity: it does not say which role attributes can be changed, nor how it differs from siblings like modx_get_role, modx_create_role, or modx_delete_role. An agent can infer mutation of a role but gains nothing it could not read from the name alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/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 prerequisites, and no mention of alternatives such as modx_get_role for reading or modx_create_role/modx_delete_role for other lifecycle operations. The description gives the agent no basis for choosing this tool over its siblings.

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