Skip to main content
Glama
vmware-skills

vmware-nsx

by vmware-skills
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

delete_segment

Destructive

Delete a network segment safely by previewing its blast radius first. Requires explicit confirmation; refuses if any port is attached.

Instructions

[WRITE] Delete a network segment; refuses while any port is attached.

Irreversible. Without confirm=True this only previews: it returns blast_radius (the segment's name, gateway, subnets, port_count and port_ids, blockers, unmeasured) and deletes nothing. Show that to the user and get their decision. Do not set confirm=True on your own because the user asked to delete earlier: they have not seen the blast radius yet.

confirm=True re-measures, then refuses, deleting nothing, while any port (a VM vNIC or router interface) is attached — it never disconnects them for you — or when the ports could not be read. Returns {"action": "preview" | "deleted", "blast_radius": ...}, else {"error", "hint", "blast_radius"?}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNoNSX Manager target from config (default if omitted).
confirmNoFalse (default) returns the blast radius and changes nothing. True applies it.
segment_idYesSegment ID to delete, as returned by list_segments.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.10.0
    • addedInput schema / properties / confirm
      Added value: +{
+  "default": false,
+  "description": "False (default) returns the blast radius and changes nothing. True applies it.",
+  "title": "Confirm",
+  "type": "boolean"
+}
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "title": "Result",
-      "type": "string"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "delete_segmentOutput",
-  "type": "object"
-}New value: +null
  2. Changed3 schema fields changedv1.8.16
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / segment_id / description
      Added value: +"Segment ID to delete, as returned by list_segments."
    • addedInput schema / properties / target / description
      Added value: +"NSX Manager target from config (default if omitted)."
  3. First observedv1.3.2

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true and readOnlyHint=false, and the description goes well beyond that: it states the operation is irreversible, explains that preview mode deletes nothing, describes what blast_radius contains, and warns that attached ports are never disconnected automatically. It also covers the error/refusal path when ports cannot be read. No contradiction with 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?

The description is well structured: action, key safety warning, preview mode, user-decision guidance, confirm behavior, and return shape. Every sentence earns its place, and the most important safety guidance is front-loaded. Despite being longer than average, it is appropriately detailed for a destructive tool.

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?

For a destructive tool with no output schema, the description is complete: it explains the preview result, the return payload shape, when deletion is refused, why the confirmation step exists, and how the agent must interact with the user. Nothing needed to call it safely is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds substantial meaning beyond the schema by explaining the confirm workflow: without confirm=True it only previews, and confirm=True re-measures and refuses if ports are attached. This is more than the schema's terse 'True applies it.' It does not describe the target parameter in prose, but the schema already covers it sufficiently.

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: "Delete a network segment" and immediately adds a distinguishing behavior: "refuses while any port is attached." This makes it clear this is the deletion tool for network segments and not a generic or softer operation, especially alongside siblings like update_segment and create_segment.

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?

The description gives explicit when-to-use and when-not-to-use guidance: preview first without confirm=True, show the blast radius to the user, and never set confirm=True unilaterally even if the user previously asked to delete. It also states the refusal condition attached ports and explains the safe invocation flow, so an agent knows exactly how to proceed.

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