Skip to main content
Glama

pbs_acme_plugin_update

Update an ACME DNS challenge plugin on PBS, with dry-run by default to preview changes before applying.

Instructions

MUTATION: update an ACME DNS challenge plugin. Dry-run by default.

MEDIUM risk — invalid new credentials break cert renewal for every domain using this plugin at the next attempt. To remove a plugin instead use pbs_acme_plugin_delete. The dry-run PLAN includes the plugin's current config with the credential blob redacted (PBS DOES return it on read — see module docstring); confirm=True executes (PUT /config/acme/plugins/{id}, synchronous — PBS returns null) and returns {"status": "ok", "result": None}. Needs PROXIMO_PBS_* config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoNew base64-encoded plugin credential/config data; omit to leave unchanged. Redacted from the PLAN preview and the audit ledger, but IS sent to PBS on confirm=True.
deleteNoProperty names to clear: 'disable' and/or 'validation-delay' (the only two the schema allows).
digestNoConfig digest for optimistic-locking the update against concurrent changes; omit to skip the check.
confirmNoFalse (default) returns a dry-run PLAN only; True executes the update.
disableNoSet to enable/disable the plugin; omit to leave unchanged.
dns_apiNoNew DNS provider API name; maps to PBS's 'api' field. Omit to leave unchanged.
plugin_idYesIdentifier of the existing ACME DNS challenge plugin to update.
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.
validation_delayNoNew validation-delay in seconds (0-172800); omit to leave unchanged.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

With no annotations, the description fully discloses mutation, dry-run default, risk, return value on confirm, and config requirements. Covers redaction of credential blob.

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?

Front-loaded with purpose and risk, well-structured with clear sections. Every sentence adds value, though slightly dense.

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 9 parameters and output schema exists, the description covers risk, behavior, alternatives, and config needs. Lacks some detail on parameter interactions but overall 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?

Schema description coverage is 100%, so baseline is 3. The description does not add significant extra meaning for parameters beyond what the schema already provides.

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 it updates an ACME DNS challenge plugin and distinguishes from the delete tool via explicit mention. The verb 'update' and resource 'plugin' are specific.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly states when to use (update) and when not (to remove, use pbs_acme_plugin_delete). Provides risk assessment and explains dry-run vs confirm behavior.

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