Skip to main content
Glama

pbs_realm_ad_update

Update an Active Directory realm configuration with a dry-run preview to verify changes before applying.

Instructions

MUTATION (MEDIUM): update an AD realm's config. Dry-run by default — the PLAN reads the realm's current config first. password, if supplied, is redacted identically to pbs_realm_ad_create's. confirm=True executes and returns a dict; synchronous, no UPID. Needs PROXIMO_PBS_* config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNoLDAP connection type; omit to leave unchanged.
portNoAD server port; omit to leave unchanged.
realmYesAD realm name to update.
capathNoCA certificate path; omit to leave unchanged.
digestNoOptional SHA256 config digest to prevent concurrent modifications.
filterNoCustom LDAP search filter; omit to leave unchanged.
verifyNoTLS verification flag; omit to leave unchanged.
base_dnNoLDAP base DN; omit to leave unchanged.
bind_dnNoLDAP bind DN; omit to leave unchanged.
commentNoOptional free-text comment; omit to leave unchanged.
confirmNoFalse (default) returns a dry-run PLAN preview; True executes the mutation.
defaultNoDefault-realm-on-login flag; omit to leave unchanged.
server1NoPrimary AD server address; omit to leave unchanged.
server2NoFallback AD server address; omit to leave unchanged.
passwordNoNew AD bind password; redacted from all plans/logs/ledger.
delete_propsNoProperty names to clear.
user_classesNoAllowed objectClass values; omit to leave unchanged.
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.
sync_attributesNoSync-attribute map string; omit to leave unchanged.
sync_defaults_optionsNoSync-defaults options string; omit to leave unchanged.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

With no annotations, the description carries the full burden. It discloses mutation, dry-run default, password redaction, synchronous execution, and no UPID. This provides adequate behavioral context.

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?

The description is information-dense and front-loaded with 'MUTATION (MEDIUM)'. It is slightly verbose but each sentence adds value. Minor redundancy but overall efficient.

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 20 parameters and an output schema, the description covers the main behavior, dry-run, confirm, and config requirements. The return format is implied by the output schema, making this sufficiently complete.

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?

The input schema has 100% description coverage, so the description adds limited value—only the dry-run behavior for confirm and password redaction. Baseline 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?

The description clearly states 'update an AD realm's config', using a specific verb and resource. This distinguishes it from sibling tools like pbs_realm_ad_create (create) and pbs_realm_ad_delete (delete).

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 explains the dry-run default behavior and the confirm parameter to execute. It also mentions the required PROXIMO_PBS_* config. While it does not explicitly list when not to use or alternative tools, the context is clear enough for an agent.

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