Skip to main content
Glama

List users

proxmox_list_users
Read-only

List Proxmox users with enabled status, expiry, realm, groups, API token count and TFA lockout state; filter by realm, group, search or enabled state to audit access.

Instructions

List Proxmox users with enabled state, expiry, realm, name, email, groups, API token count and TFA lock-out state. Use proxmox_get_user for one user's details and tokens.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "proxmox_list_users"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full unprocessed objects from the API (larger)
groupNoOnly members of this group
limitNoMaximum number of results (default 500)
realmNoOnly users of this realm, e.g. pve or pam
fieldsNo
searchNoCase-insensitive substring filter on names, IDs, tags and similar fields
enabledNoOnly enabled (true) or disabled (false) users

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false and idempotentHint=false, so the safety profile is covered. The description adds real value beyond that by disclosing what each result row contains (realm, expiry, groups, API token count, TFA lock-out), which is critical since there is no output schema. It does not mention default result capping or that unfiltered calls return all users, a minor gap.

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, no waste, and the primary capability plus the returned-field inventory come first, with the sibling routing second. Nothing could be cut without losing meaning.

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 field inventory in the description does the job of explaining return values, and the sibling pointer resolves the main ambiguity. Remaining gaps are minor: pagination/default-limit behavior and the absence of guidance on combining filters are unstated.

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 86%, so the parameters (raw, group, limit, realm, fields, search, enabled) are already documented in the schema. The description contributes no additional filter semantics or combination hints, so the baseline of 3 is appropriate.

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 ('List Proxmox users') and enumerates the returned attributes (enabled state, expiry, realm, name, email, groups, token count, TFA lock-out), which makes it immediately distinguishable from proxmox_get_user. An agent can tell what it gets without opening the 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 the agent: 'Use proxmox_get_user for one user's details and tokens.' That is a clear alternative with a selecting condition. It does not state exclusions relative to other list siblings (e.g. proxmox_list_groups, proxmox_get_guest_users), so it stops just short of full when/when-not 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