Skip to main content
Glama

pbs_tape_key_update_password

Update the password and hint for a PBS tape encryption key. Provide the new password and hint; optionally supply the current password or use force to reset via the root recovery copy.

Instructions

MUTATION: change a PBS tape encryption key's password (and hint).

RISK_MEDIUM: rotates the credential protecting tape data; PBS retains a root-only recovery copy (force=True bypasses the current-password check via it), so this is not an immediate one-way lockout — but losing track of the new password before force is available risks losing normal-user access to this key. SECRET CONTRACT: password/new_password are NEVER written to the audit ledger or the dry-run PLAN. confirm=True executes (PUT /config/tape-encryption-keys/{fingerprint}, synchronous — PBS returns null) and returns {"status": "ok", "result": None}. Needs PROXIMO_PBS_* config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kdfNoKey derivation function: 'none', 'scrypt' (default), or 'pbkdf2'.
hintYesNew password hint (no control characters, 1-64 chars). REQUIRED by PBS — cannot change the password alone.
forceNoReset the passphrase using the root-only accessible copy, bypassing the current-password check.
digestNoOptimistic-lock: 64-char lowercase hex SHA-256 of the config PBS last returned.
confirmNoFalse (default) returns a dry-run PLAN only; True executes the update.
passwordNoThe CURRENT password — required unless force=True (which resets via PBS's root-only accessible copy).
fingerprintYesFingerprint of the existing tape encryption key to update.
new_passwordYesThe new password (min 5 chars). REQUIRED.
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?

With no annotations provided, the description fully carries the burden. It explicitly states it is a mutation, details the risk of lockout, discloses the root recovery copy, the secret contract that passwords are never logged, the dry-run vs execute behavior, synchronous execution, return format, and configuration requirements.

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

Conciseness4/5

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

The description is relatively long but every sentence contributes essential information (mutation, risk, contract, behavior). It is front-loaded with the purpose and structured logically, earning its place given the sensitivity of the operation.

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?

The description explains the return format, synchronous execution, dry-run vs confirm, and configuration requirements (PROXIMO_PBS_*). It covers the key aspects needed for an agent to use the tool correctly, though it omits error conditions or what happens with invalid parameters.

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 by explaining the 'force' parameter bypasses current-password via root copy, the secret contract about password logging, and the execution flow with 'confirm'. This enhances understanding beyond 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 starts with 'MUTATION: change a PBS tape encryption key's password (and hint).' This clearly states the verb (change) and the specific resource (PBS tape encryption key's password), distinguishing it from other tape key tools like create, delete, get, list.

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 provides clear usage context with risk level, the role of 'force', and the need for confirmation. It explains when to use this tool (rotating a password) and the consequences, but does not explicitly compare with sibling tools like pbs_tape_key_create or pbs_tape_key_get.

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