Skip to main content
Glama

Add Group Member

add_group_member
DestructiveIdempotent

Add a user to a group. Returns the membership Canvas reports; if the user is already a member, Canvas returns the existing membership.

Instructions

Add a user to a group. Returns the membership Canvas reports; if the user is already a member, Canvas returns the existing membership. remove_group_member removes this membership; it does not restore any other group membership Canvas changed.

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": {
      "group_id": "<group_id>",
      "user_id": "<user_id>"
    },
    "name": "add_group_member"
  }
}

Input Schema

NameRequiredDescriptionDefault
user_idYesThe Canvas user ID to add
group_idYesThe Canvas group ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.18.19

TDQS

A4.2/5.0
Behavior4/5

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

The description adds useful behavior beyond the annotations: it explains that the tool returns the membership Canvas reports and that adding an existing member returns the existing membership. It also warns that remove_group_member will not restore other group memberships Canvas may have changed, which is meaningful side-effect context.

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

Conciseness5/5

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

The description is three focused sentences with the primary action front-loaded. Every sentence contributes either purpose, idempotent return behavior, or a relevant removal caveat.

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

Completeness4/5

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

For a simple two-parameter mutation with annotations and no output schema, the description covers purpose, idempotency, return behavior, and a removal caveat. It could be strengthened with permission requirements or error behavior, but the essential calling context is present.

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?

Both parameters are fully described in the schema, including that user_id and group_id are Canvas IDs. The description adds no parameter-specific meaning beyond the schema, so the baseline of 3 is appropriate.

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?

The description gives a specific verb and resource: add a user to a group. It is clearly distinct from the sibling remove_group_member, which it explicitly references.

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 description makes the intended use clear and names remove_group_member as the removal alternative. It does not explicitly state when not to use this tool or mention prerequisites such as group-management permissions.

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