Skip to main content
Glama
vmware-skills

vmware-storage

by vmware-skills
OverviewSchemaSourceRelated ServersScoreDiscussionsAdmin
Python
Remote

storage_iscsi_status

Read-onlyIdempotent

Checks the software iSCSI adapter state and configured send targets on an ESXi host. Use it to verify prerequisites before enabling iSCSI or modifying targets, then confirm changes took effect.

Instructions

[READ] Get the software iSCSI adapter state and configured send targets for an ESXi host.

Returns {host, enabled, hba_device, iqn, send_targets: [{address, port}]}; when the adapter is disabled, enabled=false with null device/IQN and an empty target list. Use this before storage_iscsi_enable / storage_iscsi_add_target / storage_iscsi_remove_target to check prerequisites, and afterwards to verify the change took effect.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNoOptional vCenter/ESXi target name from config.
host_nameYesESXi host name exactly as shown in vCenter inventory (FQDN or IP). Errors if not found. No host listing here — get names from vmware-monitor list_esxi_hosts.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.8.15
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / host_name / description
      Added value: +"ESXi host name exactly as shown in vCenter inventory (FQDN or IP). Errors if not found. No host listing here — get names from vmware-monitor list_esxi_hosts."
    • addedInput schema / properties / target / description
      Added value: +"Optional vCenter/ESXi target name from config."
  2. First observedv1.3.2

TDQS

A4.5/5.0
Behavior4/5

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

The description discloses the exact return shape and the important edge case for a disabled adapter: 'enabled=false with null device/IQN and an empty target list.' This adds behavioral context beyond the readOnlyHint/idempotentHint annotations, which already establish this as a safe, read-only operation. It does not mention potential errors or auth requirements, but the schema covers host lookup failure.

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 compact and front-loaded: the '[READ]' marker, resource, and return shape appear first, followed only by the disabled-adapter edge case and concrete usage guidance. Every sentence adds functional value with no redundant filler.

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 present, the description compensates by documenting the return tuple and the disabled-adapter behavior. It also explains the tool's role in the broader workflow with sibling tools, and the schema covers the required parameter semantics. The definition is complete for an agent to select and call this tool correctly.

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%, so the schema already documents both parameters thoroughly, including the required host_name format and optional target behavior. The tool description itself does not add parameter-level detail, which is acceptable given the schema richness; this lands at the baseline 3.

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 starts with the explicit verb 'Get' and names the exact resource: 'software iSCSI adapter state and configured send targets for an ESXi host.' This clearly distinguishes the tool from its sibling mutation tools like storage_iscsi_enable and storage_iscsi_add_target, as well as unrelated datastore/vSAN 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 states when to use this tool: 'Use this before storage_iscsi_enable / storage_iscsi_add_target / storage_iscsi_remove_target to check prerequisites, and afterwards to verify the change took effect.' It names the relevant alternatives and gives concrete usage timing, leaving no ambiguity about when this status check is appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools