Skip to main content
Glama

provider_modify_user_groups

Idempotent

Modify a user's group memberships by adding group references, enabling pre-populated access assignments before the user first logs in.

Instructions

Modifies the list of groups that the user with the given id belongs to. Adds a list of group references that the user with the given id belongs to. This endpoint allows for the group membership info to be pre-populated before a user logs in for the first time. PUT /cloudapi/1.0.0/users/{userUrn}/groups

Input Schema

NameRequiredDescriptionDefault
bodyYesA list of entity references.
userUrnYesuserUrn (path)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered; the description usefully adds that this is a PUT to a collection endpoint and is meant for pre-login population. However, it never resolves the critical behavioral question for a PUT on a collection: whether existing memberships are replaced (removing groups) or merged, which the sentence 'Modifies the list … Adds a list' actively muddies. No auth requirements or failure modes are mentioned.

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

Conciseness3/5

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

Three sentences restate the same core idea ('modifies the list' / 'adds a list' / 'allows group membership to be pre-populated') with the phrase 'the user with the given id' repeated each time, and the raw PUT path duplicates the annotation title. The pre-login context is useful, but roughly half the text is redundant.

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 mutation with no output schema, the description covers intent but not the two things an agent most needs: replace-vs-merge semantics and how to handle the body, whose schema is a paged collection object (page, pageSize, pageCount, resultTotal, associations) even though only `values` is required. A sentence clarifying that only the `values` array of entity references matters would close the gap.

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 coverage is 100% and both parameters are described in the schema, so the baseline is 3. The description confirms userUrn identifies the target user and that the body is a list of group references, but it adds no format details (URN shape, how to obtain group references a la provider_resolve_entity) 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?

The description names a concrete verb+resource: it modifies the group list of a specific user identified by userUrn, via PUT on /users/{userUrn}/groups. It is distinguishable from sibling reads such as provider_query_user_groups or provider_get_group, though it never says so explicitly and the internal tension between 'modifies the list' and 'adds a list' leaves the exact effect slightly fuzzy.

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?

There is one implied usage scenario: pre-populating group membership before the user first logs in. Beyond that it gives no when/when-not guidance and does not point to alternatives like provider_query_user_groups (to inspect memberships) or provider_update_group (to change a group's members).

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