Skip to main content
Glama
vmware-skills

vmware-storage

by vmware-skills
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

storage_iscsi_enable

Enable the software iSCSI adapter on an ESXi host with a preview of blast radius before applying. Requires confirmation to change, non-disruptive with no reboot.

Instructions

[WRITE] Enable the software iSCSI adapter (vmhba) on an ESXi host.

Required prerequisite before storage_iscsi_add_target. Without confirm=True this only previews: it returns blast_radius (the host, its current adapters, whether the software adapter already exists) and changes nothing. Show it to the user. Do not set confirm=True on your own because the user asked earlier — they have not seen the preview yet. Already enabled returns action "noop" with the HBA device and IQN. Non-disruptive (no reboot, no impact on existing datastores). Refused when the host's storage view cannot be read. Returns a dict; check state first with storage_iscsi_status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNoOptional vCenter/ESXi target name from config.
confirmNoFalse (default) returns the blast radius and changes nothing. True applies it.
dry_runNoDeprecated alias for confirm; removed in the next minor release. dry_run=False acts, dry_run=True previews.
host_nameYesESXi host name exactly as shown in vCenter inventory (FQDN or IP). Errors if not found.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv1.11.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 / dry_run / anyOf
      Added value: +[
+  {
+    "type": "boolean"
+  },
+  {
+    "type": "null"
+  }
+]
    • changedInput schema / properties / dry_run / default
      Previous value: -falseNew value: +null
    • changedInput schema / properties / dry_run / description
      Previous value: -"If true, return a preview of the change without executing it."New value: +"Deprecated alias for confirm; removed in the next minor release. dry_run=False acts, dry_run=True previews."
    • removedInput schema / properties / dry_run / type
      Removed value: -"boolean"
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "title": "Result",
-      "type": "string"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "storage_iscsi_enableOutput",
-  "type": "object"
-}New value: +null
  2. Changed4 schema fields changedv1.8.15
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / dry_run / description
      Added value: +"If true, return a preview of the change without executing it."
    • addedInput schema / properties / host_name / description
      Added value: +"ESXi host name exactly as shown in vCenter inventory (FQDN or IP). Errors if not found."
    • addedInput schema / properties / target / description
      Added value: +"Optional vCenter/ESXi target name from config."
  3. Changed1 schema field changedv1.6.0
    • addedInput schema / properties / dry_run
      Added value: +{
+  "default": false,
+  "title": "Dry Run",
+  "type": "boolean"
+}
  4. First observedv1.3.2

TDQS

A4.9/5.0
Behavior5/5

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

Beyond annotations, the description reveals the preview/apply split controlled by confirm, the noop behavior when already enabled, non-disruptiveness, refusal when storage view cannot be read, and that it returns a dict. These are meaningful behavioral details not encoded in the annotations. No contradiction with readOnlyHint=false or destructiveHint=false.

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?

Every sentence earns its place: purpose, prerequisite, preview semantics, noop case, safety guidance, disruption profile, failure mode, and return type. The most critical safety instruction is front-loaded and clearly stated.

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 stating the return type, the blast_radius content, the noop action with HBA device and IQN, and pointing to storage_iscsi_status for state verification. It covers prerequisites, failure conditions, and operational impact, so an agent has what it needs to call and interpret the tool.

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% and each parameter already has a description. The tool description adds extra operational meaning around confirm: without confirm=True it only previews, and the agent must not set confirm=True autonomously before the user sees the blast radius. This goes beyond the schema's basic 'True applies it' explanation.

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?

Opens with a specific verb and resource: 'Enable the software iSCSI adapter (vmhba) on an ESXi host.' It also differentiates from siblings by declaring itself 'Required prerequisite before storage_iscsi_add_target' and describing the already-enabled 'noop' case, so an agent can distinguish it from add/remove/status tools.

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 explicitly says when to use it relative to storage_iscsi_add_target, instructs the agent to 'check state first with storage_iscsi_status', and gives clear guidance not to set confirm=True without showing the preview. This is direct, actionable when-to-use and when-not-to-act 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