Skip to main content
Glama

List SDN objects

proxmox_list_sdn_objects
Read-only

List Proxmox SDN objects by kind—zones, vnets, subnets, controllers, IPAMs or DNS plugins—with filters, search and pending changes to audit uncommitted SDN edits.

Instructions

List Software-Defined Networking objects of one kind: zones, vnets, subnets of a vnet, controllers, IPAMs or DNS plugins. Use pending=true to see uncommitted changes (state new/changed/deleted). Related: proxmox_get_sdn_object for one object, proxmox_get_sdn_status for the live state on nodes.

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>"
    },
    "name": "proxmox_list_sdn_objects"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full unprocessed objects from the API (larger)
kindYesSDN object kind: zone, vnet, subnet (needs `vnet`), controller (BGP/EVPN/IS-IS), ipam or dns (DNS plugin)
typeNoOnly objects of this plugin type, e.g. vlan, vxlan, evpn, simple, qinq (zones); bgp, evpn, isis (controllers); pve, netbox, phpipam (ipams)
vnetNoVNet the subnet belongs to (required for kind=subnet)
limitNoMaximum number of results (default 500)
fieldsNo
searchNoCase-insensitive substring filter on names, IDs, tags and similar fields
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

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds real behavioral context beyond that: the pending view returns per-object state values new/changed/deleted and is tied to proxmox_apply_sdn. It still says nothing about result size, pagination, or ordering, which matters for a list tool with a 500 default limit.

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?

Three tight sentences with the resource scope front-loaded, followed by the pending rule and sibling routing. No filler, though the kind enumeration overlaps with what the schema's enum already conveys.

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?

Covers the essentials for a 9-parameter list tool: valid kinds, the subnet-needs-vnet constraint implied by the kind description, the pending view semantics, and sibling routing. With no output schema, the description leaves the returned object shape undocumented, though the pending state values are described.

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 89%, so the schema already documents kind, type, vnet, limit, search, pending, and running in detail. The description's restatement of pending and the kind list largely duplicates that, adding only the uncommitted-changes workflow framing. Baseline 3 applies when the schema does the heavy lifting.

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?

States a specific verb and resource ("List Software-Defined Networking objects") and immediately bounds the scope to one kind, enumerating the six valid kinds. This lets an agent distinguish it from the singletons proxmox_get_sdn_object and proxmox_get_sdn_status without opening the schema.

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?

Gives an explicit conditional usage rule ("Use pending=true to see uncommitted changes") plus routing to two named alternatives with the condition that selects each: proxmox_get_sdn_object for a single object, proxmox_get_sdn_status for live node state. Nothing is left to inference about when to pick this versus those siblings.

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