Skip to main content
Glama

List API tokens

proxmox_list_api_tokens
Read-only

List Proxmox VE API tokens for one user or all users, showing ID, privilege separation, expiry, and comments without exposing secrets.

Instructions

List API tokens (full ID user@realm!name, privilege separation, expiry, comment) for one user, or for all users when userid is omitted. Secrets can never be read back.

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_api_tokens"
  }
}

Input Schema

NameRequiredDescriptionDefault
fieldsNo
searchNoCase-insensitive substring filter on names, IDs, tags and similar fields
useridNoUser 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.4/5.0
Behavior4/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 genuinely non-redundant behavior: that token secrets can never be read back, which prevents an agent from attempting a secret-retrieval follow-up, plus the exact fields the listing exposes.

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, zero filler. The scope rule is front-loaded and the returned-field list and secret caveat follow in a single compact clause. Every sentence earns its place.

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?

For a read-only list tool with no output schema, the description compensates well by naming the returned fields and the security constraint. The remaining gap is the undocumented 'fields' array parameter (field projection) and the absence of any note on result volume, which the description neither covers nor defers to the schema for.

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 67%, with userid already documented in the schema (name@realm form, cross-referenced to proxmox_list_users). The description adds meaning beyond the schema by explaining the consequence of omitting userid — the result widens to all users — which the schema alone does not convey.

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 API tokens') and immediately defines scope: one user, or all users when userid is omitted. It also enumerates the returned attributes (full ID in user@realm!name form, privilege separation, expiry, comment), which cleanly separates it from the sibling get_api_token tool.

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 gives an explicit conditional for the main usage decision: omit userid to enumerate tokens across all users, supply it to scope to one. It stops short of naming alternatives (e.g. proxmox_get_api_token for a single token's details) or stating exclusions, so it is clear context without 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