Skip to main content
Glama

pbs_realm_sync

Synchronize PBS authentication realm users from LDAP/AD. Uses dry-run by default; execute with confirm=True. Optionally removes users no longer present in the directory.

Instructions

MUTATION: sync PBS auth realm (LDAP/AD) users. Dry-run by default. confirm=True to execute. Async — returns UPID. Needs PROXIMO_PBS_* config. remove_vanished=True also removes PBS users no longer in the directory. (2026-07-10 audit: the old 'scope' param was dropped — PBS /sync has no such field.)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
realmYes
confirmNo
dry_runNo
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.
remove_vanishedNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

No annotations exist, so description carries full burden. It states mutation, async return of UPID, and dry-run default, but does not explain what dry-run outputs or mention permissions/rate limits. The old param drop is helpful.

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?

The description is dense and front-loaded with key info, using a single paragraph with no fluff. Every sentence adds value.

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?

With an output schema presumably containing return details, the description covers mutation, async behavior, config, and key parameters. Dry-run behavior could be clearer, but overall adequate.

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 coverage is 20% (only proximo_target has description). The description adds meaning for realm, confirm, dry_run (though slightly inconsistent with schema default), and remove_vanished, but does not cover all parameters completely.

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 'MUTATION: sync PBS auth realm (LDAP/AD) users,' using a specific verb and resource. It distinguishes itself from sibling tools, none of which are similar sync operations.

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 dry-run default, confirm execution, and remove_vanished behavior. It lacks explicit when-not-to-use or alternatives, but the usage context is clear.

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