Skip to main content
Glama

Get guest network interfaces (agent)

proxmox_get_guest_network
Read-only

Find a running VM's IPv4/IPv6 address, MAC, prefixes, and traffic counters by listing guest network interfaces via the QEMU guest agent; containers are not supported.

Instructions

List a running VM's network interfaces as seen inside the guest (via the QEMU guest agent): name, MAC, IPv4/IPv6 addresses with prefix, and traffic counters. The reliable way to find a VM's IP address. Loopback is hidden unless include_loopback=true. VMs only; for containers use proxmox_get_container_interfaces.

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": {
      "vmid": "<vmid>"
    },
    "name": "proxmox_get_guest_network"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full unprocessed objects from the API (larger)
nodeNoNode the guest is on. Looked up automatically from the VMID when omitted.
vmidYesVM or container ID (VMID), e.g. 100
include_loopbackNoInclude the loopback interface (default false)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.4/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, it discloses the data source (QEMU guest agent, i.e. interfaces as seen inside the guest) and the default filtering behavior for loopback. What is missing is the failure mode: nothing says what happens if the guest agent is not installed or running, which is the main reason this call would return nothing.

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?

Four short sentences, front-loaded with the resource and return contents, then the IP-discovery rationale, then the filtering default, then the sibling routing. No filler or repetition.

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?

With no output schema, the description carries the return-value burden and does so by naming the fields returned. It also covers the container alternative and loopback default, but leaves the guest-agent prerequisite's consequences unstated for what is essentially an agent-dependent read.

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 all four parameters are already documented, including the include_loopback default. The description adds a little framing by calling out that loopback is hidden unless include_loopback=true, but it says nothing additional about raw or node (the latter's auto-lookup lives in the schema). Baseline 3 is appropriate.

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 opens with a specific verb and resource ('List a running VM's network interfaces') and enumerates exactly what comes back: name, MAC, IPv4/IPv6 with prefix, and traffic counters. It also differentiates from the sibling proxmox_get_container_interfaces, so an agent can pick between them without opening either 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?

It states the primary use case ('The reliable way to find a VM's IP address') and gives an explicit exclusion plus alternative ('VMs only; for containers use proxmox_get_container_interfaces'). When-to-use, when-not, and the substitute are all named rather than inferred.

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