Skip to main content
Glama

Get an SDN object

proxmox_get_sdn_object
Read-only

Retrieve full configuration for an SDN zone, VNet, subnet, controller, IPAM, or DNS plugin, including its digest and optional pending changes for optimistic locking.

Instructions

Get the full configuration of one SDN zone, vnet, subnet, controller, IPAM or DNS plugin, including its digest for optimistic locking. With pending=true, uncommitted changes are shown under pending.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "kind": "<kind>",
      "id": "<id>"
    },
    "name": "proxmox_get_sdn_object"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesObject ID (zone/vnet/controller/ipam/dns name, or subnet ID such as 'zone1-10.0.0.0-24' or its CIDR '10.0.0.0/24')
kindYesSDN object kind: zone, vnet, subnet (needs `vnet`), controller (BGP/EVPN/IS-IS), ipam or dns (DNS plugin)
vnetNoVNet the subnet belongs to (required for kind=subnet)
pendingNoInclude uncommitted changes: each object shows `state` (new/changed/deleted) and the `pending` values not yet applied with proxmox_apply_sdn
runningNoShow the running (last applied) configuration instead of the edited one

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true, openWorldHint=false), and the description still adds meaningful behavior: the returned digest exists for optimistic locking, and pending=true routes unapplied values under a `pending` key. It doesn't discuss error cases (e.g. unknown id) or the odd idempotentHint=false, but the value added beyond structured fields is real.

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?

Two tight sentences: the primary purpose and scope come first, the conditional pending behavior second. No filler, no restating of the title, and the digest/locking detail is packed into the opening clause.

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?

For a read-only lookup with rich, fully described parameters and an existing annotation safety profile, the description covers purpose, scope, locking semantics and the pending behavior. Since there is no output schema, it could say a bit more about the shape of the returned configuration, but nothing needed to invoke it correctly is missing.

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 every parameter including the kind enum and the subnet ID/CIDR formats is already documented in the schema. The description only reinforces the pending flag's meaning, which the schema already explains in equal detail, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (get) and resource (one SDN object) and enumerates the six kinds covered, plus the key output element (full configuration with digest). It implicitly separates itself from proxmox_list_sdn_objects by emphasizing 'one' object, but never names a sibling explicitly, so it stops short of full differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives one conditional usage hint — use pending=true to surface uncommitted changes — which implies when this mode is appropriate. It does not say when to prefer this tool over proxmox_list_sdn_objects or proxmox_get_sdn_pending_diff, nor does it state prerequisites or exclusions, so usage is only implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools