Skip to main content
Glama

pbs_s3_client_update

Update an existing PBS S3 client configuration with new endpoint, credentials, region, rate limits, or other properties. Supports dry-run planning before execution.

Instructions

MUTATION: update a PBS S3 client configuration.

RISK_MEDIUM: rotating credentials/endpoint/region can silently break dependent datastore/ sync configuration — mirrors pbs_remote_update. SECRET CONTRACT: secret-key (if given) is NEVER written to the audit ledger or the dry-run PLAN. Dry-run by default (captures current secret-free config into the PLAN); confirm=True executes (PUT /config/s3/{id}, synchronous — PBS returns null) and returns {"status": "ok", "result": None}. No snapshot primitive; verify with pbs_s3_check after rotating credentials. Needs PROXIMO_PBS_* config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
portNoNew port (1-65535).
s3_idYesId of the existing S3 client config to update.
deleteNoProperty names to clear: any of port/region/fingerprint/path-style/rate-in/burst-in/rate-out/burst-out/provider-quirks. access-key/secret-key/endpoint/id are NOT deletable — rotate them with a new value instead.
digestNoOptimistic-lock: 64-char lowercase hex SHA-256 of the config PBS last returned.
regionNoNew region.
confirmNoFalse (default) returns a dry-run PLAN only; True executes the update.
rate_inNoNew inbound rate limit (byte size with unit).
burst_inNoNew inbound burst limit (byte size with unit).
endpointNoNew endpoint hostname/IPv4/IPv6.
rate_outNoNew outbound rate limit (byte size with unit).
burst_outNoNew outbound burst limit (byte size with unit).
access_keyNoNew access key. NOT treated as secret.
path_styleNoUse path-style bucket addressing.
secret_keyNoNew secret key. SECRET — never written to the audit ledger or the dry-run PLAN.
fingerprintNoNew X509 certificate fingerprint.
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.
provider_quirksNoNew provider-specific implementation quirks.

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 covers behavioral traits: risk level (RISK_MEDIUM), dry-run behavior, secret key handling (never written to audit ledger or plan), synchronous execution, return value format, and lack of snapshot primitive. Also links to pbs_s3_check for verification.

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?

Description is relatively long but well-structured with clear sections (MUTATION, RISK_MEDIUM, SECRET CONTRACT). Every sentence adds value, though some redundancy exists. Could be slightly more concise without losing key details.

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 17 parameters, the description covers essential behavioral aspects (dry-run, confirmation, risk, secret handling, verification). It references output schema implicitly by noting return value for confirm=True. While lacking explicit output schema details, context signals indicate an output schema exists, but the description suffices for a mutation tool.

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% with parameter descriptions. The tool description adds value beyond schema by highlighting special behavior of 'secret_key' (not logged) and clarifying which properties are deletable. This extra context raises the score above the baseline of 3.

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?

Description clearly states 'MUTATION: update a PBS S3 client configuration', specifying verb and resource. It distinguishes from sibling tools like create, delete, get, and list by focusing on update. The mention of similarity to pbs_remote_update further clarifies its role.

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 context: dry-run by default, confirm=True executes. Highlights risk of breaking dependent datastores and recommends verification with pbs_s3_check after credential rotation. Mentions PROXIMO_PBS_* config requirement. However, it does not explicitly state when not to use this tool compared to alternatives.

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