vmware-vks

list_vm_service_network_interfaces

Read-onlyIdempotent

[READ] List the network interfaces (multi-NIC) of one VirtualMachine.

Instructions

[READ] List the network interfaces (multi-NIC) of one VirtualMachine.

Reads spec.network.interfaces[] off a single VM Service VirtualMachine (vmoperator.vmware.com) via the Supervisor K8s API; the served CRD version is discovered at runtime. Returns the family list envelope: items of {name, network_name, network_kind, network_api_version} plus returned/total/truncated and vm_name/served_version. A VM with no network block returns an empty list, not an error. Run list_namespaces for the namespace; the VM name comes from your own VM inventory in that namespace.

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": {
      "namespace": "<namespace>",
      "vm_name": "<vm_name>"
    },
    "name": "list_vm_service_network_interfaces"
  }
}

Input Schema

Name	Required	Description
`target`	No	vCenter in config.yaml; omit for the default.
`vm_name`	Yes	Name of the VirtualMachine to read interfaces from.
`namespace`	Yes	vSphere Namespace the VM lives in (via list_namespaces).

Schema Changelog

Changes observed during successful MCP inspections.

Addedv2.0.0Oct 14, 2026

TDQS

A4.2/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent/openWorld, so the bar is lower, and the description still adds real value: the CRD served version is discovered at runtime, a VM without a network block returns an empty list rather than an error, and the return envelope is described. It omits pagination/truncation semantics despite mentioning a truncated flag.

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?

Front-loaded with the [READ] marker and the core action, then a compact paragraph on mechanism and return shape. The return-envelope enumeration is slightly dense but earns its place given there is no output schema.

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?

With no output schema, the description compensates by naming the returned fields (name, network_name, network_kind, network_api_version) plus returned/total/truncated and vm_name/served_version, and it clarifies the empty-list edge case. An agent has everything needed to call and interpret the result.

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 100%, so the schema already documents target, vm_name, and namespace. The description reinforces the provenance of namespace (via list_namespaces) and vm_name (own inventory) but adds no format or syntax detail beyond the schema, which is the baseline-3 case.

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 the network interfaces (multi-NIC) of one VirtualMachine') and bounds the scope to a single VM. No sibling tool lists NICs, so an agent can select it unambiguously from the surrounding list_* family.

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 concrete routing: run list_namespaces to obtain the namespace and take the VM name from the caller's own inventory in that namespace. It stops short of naming when-not-to-use conditions or an alternative tool, so it is clear context rather than full when/when-not guidance.

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