Skip to main content
Glama

Preview SDN apply (dry run)

proxmox_get_sdn_pending_diff
Read-only

Preview staged SDN changes by comparing running and pending network interface and FRR routing configurations before applying them.

Instructions

Dry-run proxmox_apply_sdn for one node: shows the diff between the running and the pending network interfaces (/etc/network/interfaces.d/sdn) and FRR routing configuration. Use it to review staged SDN changes before applying them.

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_pending_diff"
  }
}

Input Schema

NameRequiredDescriptionDefault
nodeNoNode to compute the diff for (default PROXMOX_DEFAULT_NODE or the only node)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds genuinely useful behavior detail by naming the exact files and FRR configuration compared and confirming no mutation occurs. It does not describe return formatting or how large diffs are presented, which matters since there is no output schema, but nothing contradicts the annotations.

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 sentences, front-loaded with the dry-run framing, then the concrete artifact compared, then the intended use. No filler, and the alternative tool is named early rather than buried.

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 one-parameter read-only preview tool with full schema coverage and annotations, the definition covers purpose, scope, target files, and intended timing. The only gap is what the returned diff looks like, which would be helpful given the absence of an output schema.

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% and the single node parameter already explains its default (PROXMOX_DEFAULT_NODE or the only node). The description adds only the scoping phrase 'for one node', which is consistent but adds little beyond the schema, so baseline 3 applies.

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 states a specific action (dry-run of proxmox_apply_sdn) and the concrete resource it inspects — the pending vs. running network interfaces under /etc/network/interfaces.d/sdn plus FRR routing config. It explicitly frames itself as the preview counterpart of proxmox_apply_sdn, so an agent can distinguish it from the apply tool without reading 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 Guidelines4/5

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

It gives a clear usage condition: use it to review staged SDN changes before applying them, and names proxmox_apply_sdn as the alternative it precedes. It stops short of stating edge cases, such as what a diff shows when nothing is staged or whether the call is meaningful on a node with no SDN config.

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