Skip to main content
Glama

users_tool

Site users module on the currently selected site (call select_site first). List/profiles, groups, ranks, chlogin/chgroup/chpass. Proxies to /uapi/users/* with a server-minted Bearer key.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoGroup id (group_update, group_delete, group_permissions).
gidNoGroup id (chgroup, group_*). Synonym for id on group actions.
nidNoTarget group id when deleting a group (move members).
nameNoDisplay name (add) or group name (group_add/update).
nickNoLogin/nick (get, add, delete). Synonym: user.
pageNoPage number for list.
userNoSynonym for nick.
emailNoEmail (get, add, update).
loginNoNew login (chlogin).
actionYeslist/get — users. add/register — POST /uapi/users. update — PUT (user_id). delete — DELETE by nick/user + confirm. groups* — /uapi/users/groups. groups_rights / group_permissions — fetch permission codes before group_add/update fields. ranks / fields — profile metadata. chlogin/chgroup/chpass — user admin (chpass + confirm).
fieldsNoExtra profile fields (add/update) or group permissions (group_add/update). Use codes from groups_rights / group_permissions; do not guess permission keys.
confirmNoRequired for delete, chpass, and group_delete after explicit user approval.
user_idNoNumeric user id (get, update, chlogin, chgroup, chpass).
passwordNoPassword (add, chpass).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does add real context: the tool proxies to /uapi/users/* under a server-minted Bearer key, implying delegated auth. However it says nothing about the destructive actions (delete, group_delete, chpass) or the approval/confirm requirement, which is the most important behavioral fact for this 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?

Two dense sentences with the prerequisite front-loaded and no filler. The telegraphic action list ('List/profiles, groups, ranks, chlogin/chgroup/chpass') is compact but slightly cryptic without the schema in hand.

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 14-parameter, nested-object, no-output-schema tool, the definition covers site prerequisite and auth path but omits the destructive-action/confirm flow, pagination via page, and the distinction between ranks/fields metadata and group permissions.

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% and the action enum documents routing per action, so the baseline is 3. The description's 'List/profiles, groups, ranks, chlogin/chgroup/chpass' loosely maps to action families but adds no syntax or format detail beyond the schema.

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?

It names the resource (site users module) and scopes it to the currently selected site, then enumerates the functional families it covers: profiles, groups, ranks, chlogin/chgroup/chpass. That is more than a restated name, though it is a multi-action router rather than a single verb+resource, and it never contrasts with any sibling.

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

Usage Guidelines4/5

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

The parenthetical '(call select_site first)' gives an explicit hard prerequisite that the agent must satisfy before invoking. There are no competing user-management siblings to disambiguate against and no when-not guidance, but the sequencing context is stated concretely.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.