Skip to main content
Glama

Get API token

proxmox_get_api_token
Read-only

Retrieves an API token's privilege separation, expiry, and comment settings, plus its own ACL entries when privilege-separated. Use it to inspect a specific token's configuration.

Instructions

Get one API token's settings (privilege separation, expiry, comment) and, when privilege-separated, its own ACL entries.

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>",
      "tokenid": "<tokenid>"
    },
    "name": "proxmox_get_api_token"
  }
}

Input Schema

NameRequiredDescriptionDefault
useridYesUser ID in name@realm form, e.g. alice@pve or root@pam (see proxmox_list_users)
tokenidYesToken name (the part after '!', e.g. 'automation' for alice@pve!automation)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A3.8/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 safety is covered; the description adds genuine behavioral detail by disclosing that ACL entries are returned conditionally, only when the token is privilege-separated. It does not cover failure behavior for a nonexistent userid/tokenid, and the idempotentHint=false annotation sits oddly against a read, though the description does not contradict it.

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?

A single front-loaded sentence that names the resource, the returned settings, and the conditional ACL behavior, with no filler or repetition of the title.

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 two-parameter read tool with full schema coverage and annotations carrying the safety profile, the description is close to sufficient because it also sketches the return payload. Only error/empty-result behavior is unaddressed, which is minor given there is no output schema to lean on.

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%, and the schema itself explains the name@realm form for userid and the '!'-suffix semantics for tokenid, including an example. The description adds no parameter meaning beyond that, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/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 API token's settings') and enumerates the returned fields (privilege separation, expiry, comment), which clearly separates it from the plural sibling proxmox_list_api_tokens. The singular scope is explicit, though the differentiation is implied by 'one' rather than stated as a contrast.

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?

Usage is only implied: an agent can infer this is the lookup-by-identity counterpart to listing tokens. There is no explicit when-to-use, no prerequisites (e.g., required permissions on the user), and no named alternative for enumerating tokens.

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