Skip to main content
Glama

Update a group’s permissions

update_group
DestructiveIdempotent

Replace a Wiki.js group's name, permissions, page rules, and login redirect in one operation. Requires a confirmation token to apply changes that control wiki access.

Instructions

Replaces a group’s name, permissions, page rules and login redirect wholesale — this is not a partial update, and omitting a rule deletes it, just as omitting redirect_on_login resets it to "/". Read the group with get_group first and send back the full set with your change applied. Requires a confirmation token, because this is the call that decides who can read and edit the wiki.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
group_idYesNumeric Wiki.js id.
page_rulesYesComplete page rule set. Replaces the existing one.
permissionsYesGlobal permissions, e.g. ["read:pages","write:pages"]. Replaces the existing list.
confirm_tokenNoToken from this tool’s previous, unconfirmed call. Omit it to receive one.
redirect_on_loginNoWhere members land after signing in (default "/").

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
truncatedNoPresent only when the answer was shortened to fit the budget.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.0
    • changedInput schema / properties / group_id / maximum
      Previous value: -9007199254740991New value: +2147483647
  2. Changed2 schema fields changedv0.2.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": true,
      +  "properties": {
      +    "truncated": {
      +      "additionalProperties": true,
      +      "description": "Present only when the answer was shortened to fit the budget.",
      +      "properties": {},
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observedv0.1.2

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations, the description discloses wholesale replacement semantics, deletion on omission, redirect reset to '/', and the two-phase confirmation-token requirement. It also notes the stakes: 'this is the call that decides who can read and edit the wiki.' This is substantial behavioral context that annotations alone do not provide.

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?

Three front-loaded sentences cover the core behavior, the critical non-obvious side effects, and the required pre-step. Every sentence earns its place, with no filler or repetition of schema details.

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

Completeness5/5

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

For a destructive, two-phase update with an output schema and six well-documented parameters, the description covers the prerequisite, the confirmation-token flow, the destructive semantics, and the security significance. Nothing required to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 83%, so the schema already documents most parameters well. The description adds valuable semantics by explaining what happens when page_rules are omitted and that redirect_on_login resets to '/', which is not fully captured by the schema's default-value notation.

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 opens with 'Replaces a group’s name, permissions, page rules and login redirect wholesale,' naming a specific action, resource, and affected fields. It also explicitly says 'this is not a partial update,' which distinguishes it from patch-style operations and clarifies its scope.

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?

It gives explicit workflow guidance: 'Read the group with get_group first and send back the full set with your change applied.' It also warns about the destructive consequence of omitting fields. It does not explicitly enumerate sibling tools like create_group/delete_group as alternatives, but the usage context is clear enough.

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