Skip to main content
Glama

List IPAM entries

proxmox_get_sdn_ipam_status
Read-only

List SDN IPAM IP allocations (IP, MAC, hostname, VMID, vnet, subnet, gateway) to find which guest holds an address or which IPs are free, filtered by VM, vnet or search text.

Instructions

List the IP allocations recorded in an SDN IPAM (default the built-in 'pve' IPAM): IP, MAC, hostname, VMID, vnet/subnet and gateway entries. Use it to find which guest holds an address or which IPs are free. Related: proxmox_save_sdn_vnet_ip to add or change a mapping.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "proxmox_get_sdn_ipam_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
ipamNoIPAM ID (default 'pve')
vmidNoOnly entries of this VM/container
vnetNoOnly entries in this vnet
limitNoMaximum number of results (default 1000)
searchNoCase-insensitive substring filter on names, IDs, tags and similar fields

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare the safe read profile (readOnlyHint=true, openWorldHint=false), and the description complements that by naming the default 'pve' IPAM and the shape of the rows returned. It says nothing about result volume limits or truncation, so an agent calling it on a large cluster gets no warning about the 1000-row default.

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 front-loaded sentences; the resource and returned fields come first, usage and the related tool follow. No filler, though the field enumeration slightly duplicates what a caller would discover from a result.

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 list tool with no output schema, stating the returned fields and default IPAM is enough to call it correctly. The one missing piece is any note about paging or the result cap, which matters for a listing tool.

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 'pve' default and the limit bounds is already documented in the schema. The description merely restates the default IPAM, adding no filtering syntax or vmid/vnet interaction detail beyond what the schema provides.

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 (list) and resource (IP allocations in an SDN IPAM) and enumerates the fields returned: IP, MAC, hostname, VMID, vnet/subnet, gateway. This is clearly distinguishable from siblings like proxmox_get_sdn_status or proxmox_list_sdn_objects.

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?

Gives a concrete when-to-use: find which guest holds an address, or which IPs are free. It also points to proxmox_save_sdn_vnet_ip as the write-side counterpart, implicitly separating read from mutation, though it names no explicit when-not conditions.

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