Skip to main content
Glama

pve_user_update

Update a Proxmox user's attributes including login status, group membership, and contact info. Preview changes with dry-run mode; execute with confirmation.

Instructions

MUTATION: update a user (enable=False stops login; group changes re-scope access). Dry-run by default. confirm=True executes and returns a dict; synchronous, no UPID. Use pve_user_get to see current state first, or pve_user_delete to remove the user instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailNoOptional email address; omit to leave unchanged.
appendNoIf True, add `groups` to existing membership instead of replacing it.
enableNoWhether the account can log in; False stops login. Omit to leave unchanged.
expireNoAccount expiry as a Unix timestamp; omit to leave unchanged.
groupsNoComma-separated list of group ids; replaces membership unless append=True.
useridYesUser id to update, format 'user@realm'.
commentNoOptional free-text comment; omit to leave unchanged.
confirmNoFalse (default) returns a dry-run PLAN preview; True executes the mutation.
lastnameNoOptional last name; omit to leave unchanged.
firstnameNoOptional first name; omit to leave unchanged.
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?

Without annotations, the description fully discloses key behaviors: mutation, dry-run by default, synchronous execution, no UPID, and effects of enable and groups parameters.

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 dense sentences front-loading mutation label and essential behaviors. No wasted words; each clause contributes meaning.

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?

Covers all necessary aspects: purpose, key parameter effects, execution modes, sync behavior, and sibling guidance. Output schema exists, so return details are not required.

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

Parameters5/5

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

Adds context beyond schema: summarises confirm as dry-run vs execute, enable as login stopper, groups as scope changer, and append for additive membership. Schema coverage is 100%.

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 'MUTATION: update a user' and provides specific examples of what changes like enable and groups. It distinguishes from siblings pve_user_get and pve_user_delete.

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?

Explicitly advises using pve_user_get first and pve_user_delete as an alternative. Also explains dry-run default and confirm=True execution, guiding correct usage.

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