Skip to main content
Glama
vmware-skills

vmware-nsx

by vmware-skills
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

delete_ip_pool

Destructive

Permanently delete an IP address pool. Preview blast radius first; deletion is refused while any IP is still allocated.

Instructions

[WRITE] Permanently delete an IP address pool; refuses while IPs are allocated.

Irreversible: consumers such as transport endpoints can no longer allocate. Without confirm=True this only previews: it returns blast_radius (the pool's name, pool_usage, allocation_count, realized_allocation_count and allocated_ips, 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 refuses while any IP is still allocated — in Policy ip-allocations or in NSX's pool_usage count, which also covers TEP addresses — or when either count 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.
pool_idYesIP pool ID to delete, as returned by list_ip_pools.

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_ip_poolOutput",
-  "type": "object"
-}New value: +null
  2. Changed3 schema fields changedv1.8.16
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / pool_id / description
      Added value: +"IP pool ID to delete, as returned by list_ip_pools."
    • addedInput schema / properties / target / description
      Added value: +"NSX Manager target from config (default if omitted)."
  3. Addedv1.6.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, but the description adds substantial behavioral context beyond that: the two-phase preview/confirm flow, the refusal conditions (allocated IPs in Policy or NSX pool_usage, including TEP addresses), the irreversibility, and the exact return shape. It also discloses failure modes with the error/hint/blast_radius response. This is rich, non-redundant behavioral disclosure.

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 dense but every sentence earns its place. It front-loads the core action and constraint, then explains the preview/confirm flow, refusal conditions, and return format in a compact, well-structured way. The use of quoted keys and a clear conditional structure makes it easy to parse. No filler or repetition.

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 remarkably complete. It covers the action, the safety mechanism, the exact conditions under which deletion is refused, the return values for both success and failure, and the required user-decision workflow. An agent has everything needed to invoke this tool correctly and safely.

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 description coverage is 100%, so the baseline is 3. The description adds meaning beyond the schema by explaining the semantics of confirm: 'False (default) returns the blast radius and changes nothing. True applies it.' It also clarifies that pool_id comes from list_ip_pools, which is already in the schema but reinforced. The description doesn't add much about target, but the schema already covers it. Overall, the description adds meaningful value on top of the schema.

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: 'Permanently delete an IP address pool' and immediately adds the key constraint 'refuses while IPs are allocated.' This clearly distinguishes it from sibling tools like create_ip_pool, list_ip_pools, and get_ip_pool_usage. The [WRITE] prefix and the explicit irreversibility statement leave no ambiguity about what the tool does.

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: it instructs the agent to first run without confirm=True to preview the blast radius, show that to the user, and get their decision. It explicitly warns against setting confirm=True on the agent's own initiative even if the user previously asked to delete. This is model behavior for usage guidance.

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