Skip to main content
Glama

pve_mapping_usb_update

Update a USB cluster mapping in Proxmox with optional dry-run planning. Requires confirmation to apply changes; existing VMs using the mapping may lose USB passthrough until restarted.

Instructions

MUTATION: update a USB cluster mapping. Dry-run by default (reads current config into the PLAN); confirm=True executes and returns {"status": "ok", "result": null} (no further payload). MEDIUM risk — a running VM holding this mapping may lose USB passthrough until restarted. No snapshot primitive; re-apply the captured config to revert, or use pve_mapping_usb_delete to remove the mapping outright.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
mapNoUSB device map string(s) defining the physical device(s) covered by this mapping
digestNoOptional config digest for optimistic-concurrency check against the current config
confirmNoFalse (default) returns a dry-run PLAN only; True executes the update
mapping_idYesID of the existing USB cluster mapping to update
descriptionNoOptional free-text description to set on the mapping
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?

No annotations exist, so the description carries the full burden. It discloses the mutation nature, dry-run behavior, medium risk of USB passthrough loss, lack of snapshot primitive, and how to revert (re-apply config or delete). This is comprehensive.

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 short, front-loaded with the mutation tag, and every sentence adds value. It is well-structured with clear sections.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (mutation with dry-run, risk, revert), the description covers all essential aspects: purpose, behavior, risk, recovery, and return format. No gaps.

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 extra meaning beyond the schema's parameter descriptions. It explains confirm and dry-run behavior but not the other parameters.

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 a USB cluster mapping, with explicit 'MUTATION:' prefix and details about dry-run and confirm modes. It distinguishes itself from siblings like pve_mapping_usb_create and pve_mapping_usb_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?

It provides clear context on when to use dry-run (default) versus confirm=True to execute, and mentions risk and recovery options. However, it does not explicitly compare to sibling tools for when to update vs recreate or delete.

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