Skip to main content
Glama

pbs_acl_update

Grant or revoke a PBS ACL entry to manage access permissions on a specified path for a user or group.

Instructions

MUTATION (HIGH): grant or revoke a PBS ACL entry (PUT /access/acl) — this GRANTS or REVOKES AUTHORITY, so it is treated as HIGH risk unconditionally on this plane (PBS's ACL-inheritance/shadow semantics are not schema-documented or live-verified here, unlike PVE's plan_acl_modify which computes a shadow/widen preview — every change here is flagged HIGH rather than risk under-flagging one this module cannot yet analyze).

Dry-run by default (reads the current entries at this exact path for context). Exactly one of auth_id (a user or token principal) / group is required — PBS's PUT /access/acl carries a single 'role' (not PVE's comma-separated multi-role list) and folds user+token identity into one 'auth-id' field. delete=False = grant; delete=True = revoke. confirm=True executes and returns a dict; synchronous, no UPID. Use pbs_acl_get to see current entries or pbs_roles_list to see PBS's fixed set of built-in roles. Needs PROXIMO_PBS_* config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesACL path the entry applies to, e.g. '/datastore/ds1' or '/'.
roleYesA single PBS role id to grant or revoke, e.g. 'DatastoreAdmin'.
groupNoGroup principal. Exactly one of auth_id/group is required.
deleteNoFalse to grant the role, True to revoke it.
digestNoOptional SHA256 config digest to prevent concurrent modifications.
auth_idNoUser or token principal ('user@realm' or 'user@realm!token-name'). Exactly one of auth_id/group is required.
confirmNoFalse (default) returns a dry-run PLAN preview; True executes the mutation.
propagateNoWhether the grant propagates to child paths below `path`; omit for PBS's default (true).
proximo_targetNoWhich configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

No annotations are provided, so the description carries full burden. It discloses the mutation is HIGH risk, dry-run by default, synchronous, returns a dict, no UPID, and requires exactly one of auth_id/group. It explains risk reasoning and limitations regarding ACL inheritance.

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 a single, well-structured paragraph. It is front-loaded with 'MUTATION (HIGH)' and covers all essential aspects without being overly verbose. Every sentence adds necessary information, and the formatting uses clear punctuation for readability.

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?

Given the complexity of the tool, no annotations, and presence of output schema, the description covers purpose, usage, parameter constraints, behavior, return value (dict), and configuration requirements. It is complete enough for an agent to select and invoke correctly.

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 100%, so baseline is 3. The description adds value beyond schemas by explaining the requirement for exactly one of auth_id/group, the meaning of delete and confirm, and the single-role constraint. It provides context that complements the schema.

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 clearly states the tool grants or revokes PBS ACL entries. It specifies the verb (grant/revoke), resource (PBS ACL entry), and distinguishes from sibling tools like pbs_acl_get (read current entries) and pbs_roles_list (list roles). The comparison to pve_acl_modify further clarifies differentiation.

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

Usage Guidelines5/5

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

Provides explicit guidance on when to use (grant or revoke ACL) and when not (if shadow preview like PVE is needed). Mentions alternatives (pbs_acl_get, pbs_roles_list). Explains dry-run behavior, required config (PROXIMO_PBS_*), and the single-role format.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/john-broadway/proximo'

If you have feedback or need assistance with the MCP directory API, please join our Discord server