Skip to main content
Glama

pbs_realm_openid_delete

Delete an OpenID realm permanently. Dry-run shows a plan; confirm=true executes removal and revokes user login access.

Instructions

MUTATION (MEDIUM): permanently delete an OpenID realm. Dry-run by default — the PLAN reads the realm's current config and flags that any users authenticating via it lose login access. confirm=True executes and returns a dict; synchronous, no UPID. Needs PROXIMO_PBS_* config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
realmYesOpenID realm name to delete.
digestNoOptional SHA256 config digest to prevent concurrent modifications.
confirmNoFalse (default) returns a dry-run PLAN preview; True executes the mutation.
proximo_targetNoWhich configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Discloses mutation level (MEDIUM), permanent deletion, dry-run plan behavior, user access impact, synchronous execution, and return type. No annotations exist, so the description fully covers behavioral traits.

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?

Highly efficient, front-loaded with mutation level and purpose. Each sentence adds necessary information without redundancy. Four sentences cover purpose, behavior, execution, and requirements.

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?

Given an output schema exists and no annotations, the description adequately covers the tool's behavior, including dry-run, execution, return type, and config needs. Minor omission: error conditions or prerequisites are not detailed, but overall sufficient.

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 100%, so each parameter is described in schema. The description adds value by explaining the dry-run vs. confirm semantics and the plan's purpose, going beyond the schema's basic parameter descriptions.

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?

The description clearly states 'permanently delete an OpenID realm', a specific verb and resource. It distinguishes itself from sibling tools like pbs_realm_openid_create, get, list, update by focusing solely on deletion.

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?

Provides clear guidance on dry-run vs. execution via confirm parameter, mentions config requirements (PROXIMO_PBS_*), and implies usage context as a mutation tool. Does not explicitly state when not to use, but the purpose is narrow enough.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/john-broadway/proximo'

If you have feedback or need assistance with the MCP directory API, please join our Discord server