Skip to main content
Glama

Get user

proxmox_get_user
Read-only

Retrieve a Proxmox VE user's configuration, including enabled status, expiry, email, groups, API tokens, and TFA entries; use the permissions tool for effective rights.

Instructions

Get one user's configuration: enabled state, expiry, name, email, groups, comment, API tokens and TFA entries. For effective permissions use proxmox_get_permissions.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "userid": "<userid>"
    },
    "name": "proxmox_get_user"
  }
}

Input Schema

NameRequiredDescriptionDefault
useridYesUser ID in name@realm form, e.g. alice@pve or root@pam (see proxmox_list_users)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds real value by disclosing the returned field set in the absence of an output schema, but it says nothing about handling of sensitive data (whether API tokens/TFA entries are masked) or about permissions needed to read another user's record.

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 sentences, front-loaded with the resource and its contents, followed by the disambiguation pointer. Nothing is redundant and no sentence is filler.

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?

With no output schema, the description correctly compensates by listing the returned fields, and a single required parameter is fully covered elsewhere. The only shortfall is the absence of any note on sensitive fields (tokens, TFA) or required privileges, which matters for a per-user configuration read.

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?

There is one parameter at 100% schema description coverage, and the schema already explains the name@realm format with examples and points to proxmox_list_users. The description adds no further semantics about the userid, so the baseline 3 applies.

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?

States a specific verb and resource ("Get one user's configuration") and enumerates what that configuration contains: enabled state, expiry, name, email, groups, comment, API tokens and TFA entries. It also names the sibling that covers a different question, so the agent can separate this from proxmox_get_permissions without opening either schema.

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?

Explicitly routes permission-related lookups to proxmox_get_permissions, which is the main ambiguity for a single-user getter. It gives no explicit when-not guidance beyond that (e.g. listing all users is left to the schema's mention of proxmox_list_users), so it stops just short of full routing guidance.

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