Skip to main content
Glama

pve_mapping_pci_update

Update an existing PCI cluster mapping. Supports dry-run planning and optional config digest for optimistic concurrency checks.

Instructions

MUTATION: update a PCI 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 need a restart to pick up the new device path. No snapshot primitive; re-apply the captured config to revert, or use pve_mapping_pci_delete to remove the mapping outright.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
mapNoPCI 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 PCI 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?

With no annotations, the description fully discloses: mutation, dry-run behavior, confirm flag usage, return payload, risk of VM restart, and absence of snapshot primitive. This gives the agent complete transparency.

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 concise (three sentences), front-loaded with 'MUTATION', and efficiently covers purpose, behavior, risk, and alternatives without redundancy.

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 complexity, presence of output schema, and sibling tools, the description is complete. It addresses behavior, risk, and recovery options, leaving no critical 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 coverage is 100%, so baseline is 3. The description does not add significant parameter-specific details beyond what the schema provides, though it does contextualize the confirm parameter and dry-run behavior.

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 this tool updates a PCI cluster mapping, distinguishing it from siblings like pve_mapping_pci_delete. It specifies the update action and the dry-run default behavior.

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?

The description explains when to use dry-run vs confirm, outlines rollback options (re-apply config or delete), and notes the medium risk of VM restart. It provides clear context for usage and 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