Skip to main content
Glama
vmware-skills

vmware-avi

by vmware-skills
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

vs_toggle

Destructive

Enable or disable a Virtual Service, showing impact (VIPs, pools, member counts) for confirmation before applying the change.

Instructions

[WRITE] Enable or disable a Virtual Service. Disabling stops all traffic to it.

Without confirm=True this only previews: it returns blast_radius (the VS name and uuid, whether it is enabled now, its VIPs and oper status, and the pools and member counts behind it) and changes nothing. Show that to the user and get their explicit decision. Do not set confirm=True on your own because the user asked earlier: they have not seen what it changes yet. A VS already in the requested state returns action "noop".

Refused with confirm=True: a VS whose uuid or pools cannot be read (the change would be blind). Use vs_status first to check current state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesExact Virtual Service name.
enableYestrue to enable, false to disable.
confirmNoFalse (default) returns the blast radius and changes nothing. True applies it.
confirmedNoDeprecated alias for confirm; removed in the next minor release. confirmed=False holds even when confirm=True.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 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"
+}
    • addedInput schema / properties / confirmed / anyOf
      Added value: +[
+  {
+    "type": "boolean"
+  },
+  {
+    "type": "null"
+  }
+]
    • changedInput schema / properties / confirmed / default
      Previous value: -falseNew value: +null
    • changedInput schema / properties / confirmed / description
      Previous value: -"Gates the disable only. With enable=false, the default false returns a preview naming the VS that would stop serving traffic and changes nothing; true performs the disable. Ignored when enable=true — enabling always executes."New value: +"Deprecated alias for confirm; removed in the next minor release. confirmed=False holds even when confirm=True."
    • removedInput schema / properties / confirmed / type
      Removed value: -"boolean"
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "title": "Result",
-      "type": "string"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "vs_toggleOutput",
-  "type": "object"
-}New value: +null
  2. Changed4 schema fields changedv1.8.14
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / confirmed / description
      Added value: +"Gates the disable only. With enable=false, the default false returns a preview naming the VS that would stop serving traffic and changes nothing; true performs the disable. Ignored when enable=true — enabling always executes."
    • addedInput schema / properties / enable / description
      Added value: +"true to enable, false to disable."
    • addedInput schema / properties / name / description
      Added value: +"Exact Virtual Service name."
  3. Addedv1.5.29
  4. Removedv1.5.28
  5. First observedv1.5.22

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already carry destructiveHint=true and readOnlyHint=false, but the description adds substantial behavioral context: the two-phase preview/confirm flow, the 'noop' response for already-requested state, and the refusal condition when the VS cannot be read. These are not derivable from annotations or schema, and they give the agent a precise model of side effects and edge cases.

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?

The description is dense and well-structured: purpose first, then preview behavior, then warnings and refusal. It is a little long, but every sentence carries critical information; there is no filler. A 4 is fair because it could be tightened slightly without losing meaning, but it is far from verbose.

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 mutation tool with no output schema, the description covers everything an agent needs: it details the return payload of the preview (blast_radius fields), the noop case, the refusal condition, and the interaction with vs_status. Given the tool's complexity and the absence of an output schema, this is remarkably complete.

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

Parameters5/5

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

Schema covers all parameters with descriptions, but the tool description deepens meaning: it explains that confirm=False is a dry-run that returns blast_radius, that confirm=True applies the change, and that the deprecated 'confirmed' alias behaves unexpectedly (confirmed=False overrides confirm=True). This level of nuance is essential for correct invocation and goes well beyond the schema text.

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 clear verb and resource ('Enable or disable a Virtual Service') and specifies the exact effect ('Disabling stops all traffic to it'). It also includes a [WRITE] tag, which flags mutation, and distinguishes this from read-only siblings like vs_status and vs_list by focusing on the state change action.

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 guidance: without confirm=True it is a preview, and the agent must show the blast radius to the user and get their decision before applying. It explicitly warns against setting confirm=True prematurely and even mentions using vs_status first to check current state. This is textbook alternative routing and preconditioning.

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