Skip to main content
Glama

pve_sdn_ipam_update

Update an existing SDN IPAM integration in Proxmox VE. Dry-run returns a plan for review; confirm to stage the edit.

Instructions

MUTATION: update an SDN ipam integration (PENDING). type is IMMUTABLE.

token (if given) is redacted in the returned PLAN and never written to the audit ledger. To create a new integration use pve_sdn_ipam_create; to remove one use pve_sdn_ipam_delete. Dry-run by default (returns a PLAN, with the current config CAPTURED and redacted); confirm=True stages the edit and returns {status, result}. RISK_LOW (staging).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoNew ipam API base URL.
ipamYesExisting SDN ipam integration id to update.
tokenNoNew ipam API token — a SECRET, masked in plans/the ledger; forwarded raw on the wire.
deleteNoField names to unset.
digestNoExpected config digest for optimistic-concurrency checking.
confirmNoFalse (default) returns a dry-run PLAN only; True executes the staged mutation.
sectionNoNew phpipam section id.
lock_tokenNoSDN cluster lock token to use for this write, if one is held.
fingerprintNoCertificate SHA-256 fingerprint (colon-separated hex byte pairs).
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
Behavior4/5

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

With no annotations, the description fully covers behavioral traits: mutation, immutability of 'type', token redaction, dry-run default, confirm behavior, and risk level. It also mentions output format (PLAN, {status, result}). Minor omissions (e.g., optimistic concurrency with digest) are covered by the schema.

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 extremely concise: four sentences with no wasted words. It is front-loaded with 'MUTATION', and every sentence provides essential information. Perfect for a busy agent.

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 the tool's complexity (10 parameters, siblings, output schema), the description covers the mutation nature, dry-run/confirm, token handling, risk, and alternative tools. It does not explain the meaning of 'PENDING' in parentheses or detail the output schema (but output schema exists). Overall, it is sufficiently 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 covers all 10 parameters with detailed descriptions (100% coverage), so baseline is 3. The description adds value by stating that 'type' is immutable (not a parameter) and that 'token' is redacted, but does not elaborate on other parameters beyond the schema.

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 starts with 'MUTATION: update an SDN ipam integration,' clearly specifying the verb (update) and the resource (SDN ipam integration). It distinguishes from sibling tools by referencing create and delete alternatives. The purpose is unambiguous.

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?

Explicitly states when to use create (pve_sdn_ipam_create) and delete (pve_sdn_ipam_delete) as alternatives, and explains the dry-run vs. confirm workflow. It does not provide exhaustive when-not-to-use guidance, but the context is clear enough for an agent.

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