Skip to main content
Glama

modx_grant_resourcegroup_access

Grant a user group access to a resource group by assigning an access policy and optional minimum role authority.

Instructions

Grant a user group access to a resource group with a policy and minimum role authority.

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": {
      "principal": "<principal>",
      "target": "<target>",
      "policy": "<policy>"
    },
    "name": "modx_grant_resourcegroup_access"
  }
}

Input Schema

NameRequiredDescriptionDefault
policyYesAccess policy id.
targetYesResource group id.
authorityNoMinimum role authority (0 = all).
principalYesUser group id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

B3.4/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full behavioral burden and only implies mutation via 'Grant'. It does not say whether the call fails or overwrites when the principal already holds an entry for that target (the key update-vs-grant distinction), whether elevation/superuser rights are required, or whether the change is idempotent or reversible.

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 zero filler or redundancy. It is tight and readable, though arguably too terse for a privilege-mutating operation.

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 four-parameter permission-granting mutation with no annotations and no output schema, the description covers the what but omits conflict/failure behavior, permission requirements, and the effect on the resource group's existing access list. Adequate minimum, but significant behavioral gaps remain.

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 100%, so the baseline is 3; the description only restates that a policy and a minimum role authority are involved, which the schema already documents for all four properties. It adds no format, range, or lookup guidance (e.g., how to obtain a valid policy id or role authority level) beyond the schema.

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

Purpose5/5

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

States a specific verb ('Grant') plus the exact triple being related: user group, resource group, access policy with minimum role authority. This clearly distinguishes it from sibling operations like modx_revoke_resourcegroup_access, modx_update_resourcegroup_access, and modx_list_resourcegroup_access.

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

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The grant semantics imply when to use it (establishing a new ACL entry), but it never names the alternatives—update vs revoke vs list resourcegroup access—or the condition that would route an agent to modx_update_resourcegroup_access instead. No prerequisites or 'when not to use' guidance is given.

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