Skip to main content
Glama

pve_sdn_ipam_create

Create a new SDN IPAM integration (netbox/phpipam/pve). Returns a dry-run plan by default; confirm=True executes the mutation.

Instructions

MUTATION: create an SDN ipam integration (PENDING — inert until pve_sdn_apply).

ipam_type is netbox/phpipam/pve; url/token/section/fingerprint are all OPTIONAL on create and shared identically across all 3 types (no per-type field variation in this schema). token is a SECRET — redacted to "[redacted]" in the returned PLAN and never written to the audit ledger; the real create call still carries it raw. To update an existing integration use pve_sdn_ipam_update; to remove one use pve_sdn_ipam_delete. Dry-run by default (returns a PLAN); confirm=True creates the pending integration, returning {status, result}. RISK_LOW (staging, no live network effect).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoIpam API base URL (netbox/phpipam).
ipamYesNew SDN ipam integration id to create.
tokenNoIpam API token — a SECRET, masked in plans/the ledger; forwarded raw on the wire so the create actually works.
confirmNoFalse (default) returns a dry-run PLAN only; True executes the staged mutation.
sectionNoPhpipam section id.
ipam_typeYesIpam type: netbox, phpipam, or pve.
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
Behavior5/5

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

No annotations provided, so the description fully covers behavioral traits: it is a mutation (MUTATION), creates a pending state (inert until apply), dry-run by default, token is a SECRET (masked in plans/ledger but sent raw), and includes risk level (RISK_LOW).

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?

The description is well-structured with clear labels (MUTATION, RISK_LOW) and logical flow. It is informative without being verbose, but a few words could be trimmed without losing clarity.

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 complexity (9 parameters, no annotations, output schema present), the description covers all necessary aspects: creation flow, pending state, dry-run, secret handling, and sibling references. It leaves no critical gaps for an AI agent.

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%, so baseline is 3. The description adds meaningful context beyond the schema: explains that ipam_type must be one of three values, that url/token/section/fingerprint are optional across all types, and that token is secret. This elevates the score slightly.

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 explicitly states it's a mutation to create an SDN IPAM integration, lists the supported types (netbox/phpipam/pve), and distinguishes itself from siblings (pve_sdn_ipam_delete, pve_sdn_ipam_update) by naming them directly.

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?

Provides clear when-to-use context: creating a pending integration that is inert until pve_sdn_apply is called. Explicitly mentions dry-run behavior (confirm=False) and when to use siblings for updates or deletions.

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