Skip to main content
Glama

Get realm

proxmox_get_realm
Read-only

Retrieve an authentication realm's configuration, including servers, base DN, sync options, and OpenID issuer, to inspect settings while keeping bind passwords and client keys redacted.

Instructions

Get an authentication realm's configuration (servers, base DN, sync options, OpenID issuer...). Bind passwords and client keys are redacted.

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": {
      "realm": "<realm>"
    },
    "name": "proxmox_get_realm"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesRealm (authentication domain) ID, e.g. pam, pve or a configured LDAP/AD/OpenID realm (see proxmox_list_realms)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

B3.4/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 safety is covered. The description adds one genuinely useful behavioral fact beyond them – that bind passwords and client keys are redacted in the output – but says nothing about error behavior for unknown realms or whether sync state is live or cached.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two compact sentences with the resource and payload front-loaded and the redaction caveat placed second where it belongs. No wasted words, though it is terse enough that a little more scoping would not have hurt.

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?

A read-only single-parameter getter with no output schema and full annotation coverage needs little, and the redaction note covers the main surprise. Still, an agent gets no signal about failure modes for an unknown realm or which config sections are omitted when a backend type does not apply.

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 single realm parameter already documents accepted values (pam, pve, LDAP/AD/OpenID) plus a cross-reference to proxmox_list_realms. The description adds no meaning beyond the schema, 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 an authentication realm's configuration') and even enumerates the content returned (servers, base DN, sync options, OpenID issuer). It does not differentiate itself from sibling getters in the description text, so it stops short of a 5.

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 implied by the read-only inspector framing, but the description contains no explicit when-to-use or when-not guidance and does not name alternatives. The pointer to proxmox_list_realms appears only in the schema's parameter description, not in the tool description.

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