Skip to main content
Glama

create_vm_user

Create a new user account inside a Proxmox VM using the guest agent. Specify node, VM ID, and username, with optional groups, shell, password, or SSH keys.

Instructions

Create a new user in a VM (requires guest agent)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nodeYesNode where VM is located
vmidYesVM ID
shellNoShell (e.g., '/bin/bash')
groupsNoComma-separated list of groups
passwordNoPassword (optional, for password auth)
ssh_keysNoSSH public keys (optional, for key auth)
usernameYesUsername to create
Behavior3/5

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

With no annotations, the description carries the disclosure burden. It does add value by noting the guest agent dependency, which is a non-obvious behavioral requirement. However, it does not disclose side effects, error conditions, reversibility, or required permissions for this mutation operation.

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 sentence of seven words that conveys the core purpose and a key prerequisite. It is extremely concise with no filler or redundant content.

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

Completeness3/5

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

For a mutation tool with no annotations and no output schema, the description is minimal. It explains what and the guest agent requirement, but it does not clarify whether password or ssh_keys is required for access, what a successful result looks like, or common failure modes. The schema covers parameter names but not operational context.

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 the schema already fully documents all parameters. The description adds no parameter-specific meaning beyond what the schema provides, which is acceptable given the full coverage.

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 'Create a new user in a VM' with a specific verb and resource, and includes the prerequisite that it requires a guest agent. This unambiguously distinguishes it from sibling tools like set_vm_user_password or run_vm_command.

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 mentions the prerequisite 'requires guest agent', implying it should only be used when the guest agent is available. However, it does not explicitly state when to prefer this tool over alternatives (e.g., set_vm_user_password) or provide exclusion conditions beyond the guest agent requirement.

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/jskoetsier/proxmox-mcp-server'

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