Skip to main content
Glama

Set Page Restrictions

confluence_set_page_restrictions
DestructiveIdempotent

Set or replace Confluence page view and edit restrictions for specified users and groups; omit all lists to remove restrictions.

Instructions

Set view and edit restrictions on a Confluence page.

Replaces all existing restrictions with the provided lists. Omitting all parameters (or passing empty lists) removes all restrictions.

Input Schema

NameRequiredDescriptionDefault
page_idYesThe ID of the page to restrict
edit_usersNo(Optional) Account IDs (Cloud) or usernames (Server/DC) allowed to edit the page.
read_usersNo(Optional) Account IDs (Cloud) or usernames (Server/DC) allowed to view the page. Empty list = unrestricted.
edit_groupsNo(Optional) Group names allowed to edit the page.
read_groupsNo(Optional) Group names allowed to view the page.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv1.4.1
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / edit_groups / items
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / edit_users / items
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / read_groups / items
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / read_users / items
      Added value: +{
      +  "type": "string"
      +}
    • removedOutput schema / description
      Removed value: -"Generic wrapper for non-object return types."
  2. Addedv1.2.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true, idempotentHint=true, and readOnlyHint=false, so the safety profile is known. The description adds the crucial detail that this is a full replace rather than a merge, plus that passing empty/omitted lists clears all restrictions — the single most important behavioral fact here. What is missing is the permission level required to apply restrictions.

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?

Two short sentences with zero filler; the core action is front-loaded and the destructive replace semantics follow immediately. Nothing is redundant with the title or schema.

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?

An output schema exists, so return values need no explanation, and the destructive/idempotent annotations are reinforced rather than contradicted. For a destructive permission mutation, the remaining gap is operational context: required permissions and where to source valid account IDs or group names.

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 page_id, read/edit users, and read/edit groups are all documented in the schema, including the Cloud-vs-Server/DC account ID difference. The description adds nothing parameter-specific beyond confirming that lists are wholesale replacements, so the baseline 3 applies.

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?

States a specific verb and resource ("Set view and edit restrictions on a Confluence page"), which clearly distinguishes it from the read-only sibling confluence_get_page_restrictions. It does not name that sibling explicitly, so differentiation relies on the get/set verb contrast rather than prose.

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 description explains the replacement semantics and the omit-all-params escape hatch, which tells an agent how the call behaves once chosen. It never states when to use this versus confluence_check_content_permissions or confluence_get_page_restrictions first, and gives no prerequisite guidance (e.g., admin rights, resolving account IDs via confluence_search_user).

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