vmware-storage 1.2.0__tar.gz

vmware_storage-1.2.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.eggs/
+.env
+*.log
+.DS_Store
+.venv/
+.mcpregistry_*
+mcp-publisher

vmware_storage-1.2.0/Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+RUN pip install --no-cache-dir uv
+
+COPY pyproject.toml .
+COPY vmware_storage/ vmware_storage/
+COPY mcp_server/ mcp_server/
+
+RUN uv pip install --system .
+
+CMD ["python", "-m", "mcp_server"]

vmware_storage-1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wei Zhou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vmware_storage-1.2.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: vmware-storage
+Version: 1.2.0
+Summary: VMware vSphere storage management: datastores, iSCSI, vSAN. Domain-focused MCP skill.
+Author: Wei Zhou / 周崴
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: mcp[cli]<2.0,>=1.0
+Requires-Dist: pyaml<27.0,>=24.0
+Requires-Dist: python-dotenv<2.0,>=1.0
+Requires-Dist: pyvmomi<10.0,>=8.0.3.0
+Requires-Dist: rich<15.0,>=13.0
+Requires-Dist: typer<1.0,>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest-cov<8.0,>=5.0; extra == 'dev'
+Requires-Dist: pytest<10.0,>=8.0; extra == 'dev'
+Requires-Dist: ruff<1.0,>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<!-- mcp-name: io.github.zw008/vmware-storage -->
+# VMware Storage
+
+[English](README.md) | [中文](README-CN.md)
+
+Domain-focused VMware vSphere storage management: datastores, iSCSI, vSAN.
+
+> **Part of the VMware MCP Skills family:**
+>
+> | Skill | Scope | Tools |
+> |-------|-------|:-----:|
+> | **vmware-monitor** (read-only) | Inventory, health, alarms, events | 8 |
+> | **vmware-aiops** (full ops) | VM lifecycle, deployment, guest ops, plans | 33 |
+> | **vmware-storage** (this) | Datastores, iSCSI, vSAN | 11 |
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+## Quick Install
+
+```bash
+# Via PyPI
+uv tool install vmware-storage
+
+# Or pip
+pip install vmware-storage
+```
+
+## Configuration
+
+```bash
+mkdir -p ~/.vmware-storage
+cp config.example.yaml ~/.vmware-storage/config.yaml
+# Edit with your vCenter/ESXi credentials
+
+echo "VMWARE_MY_VCENTER_PASSWORD=your_password" > ~/.vmware-storage/.env
+chmod 600 ~/.vmware-storage/.env
+
+# Verify
+vmware-storage doctor
+```
+
+## MCP Tools (11)
+
+| Category | Tools | Type |
+|----------|-------|------|
+| Datastore | `list_all_datastores`, `browse_datastore`, `scan_datastore_images`, `list_cached_images` | Read |
+| iSCSI | `storage_iscsi_enable`, `storage_iscsi_status`, `storage_iscsi_add_target`, `storage_iscsi_remove_target`, `storage_rescan` | Read/Write |
+| vSAN | `vsan_health`, `vsan_capacity` | Read |
+
+## CLI
+
+```bash
+# Datastore
+vmware-storage datastore list
+vmware-storage datastore browse datastore01
+vmware-storage datastore scan-images datastore01
+
+# iSCSI
+vmware-storage iscsi status esxi-01
+vmware-storage iscsi enable esxi-01
+vmware-storage iscsi add-target esxi-01 192.168.1.100
+vmware-storage iscsi remove-target esxi-01 192.168.1.100
+vmware-storage iscsi rescan esxi-01
+
+# vSAN
+vmware-storage vsan health Cluster-Prod
+vmware-storage vsan capacity Cluster-Prod
+
+# Diagnostics
+vmware-storage doctor
+```
+
+## MCP Server
+
+```bash
+# Run directly
+python -m mcp_server
+
+# Or via Docker
+docker compose up -d
+```
+
+### Agent Configuration
+
+Add to your AI agent's MCP config:
+
+```json
+{
+  "mcpServers": {
+    "vmware-storage": {
+      "command": "vmware-storage-mcp",
+      "env": {
+        "VMWARE_STORAGE_CONFIG": "~/.vmware-storage/config.yaml"
+      }
+    }
+  }
+}
+```
+
+## Why a Separate Skill?
+
+`vmware-aiops` has 33 MCP tools — too heavy for local LLMs (7B-14B). By splitting storage into its own skill:
+
+- **11 tools** — fits comfortably in small model context windows
+- **Domain-focused** — storage admins get only what they need
+- **Composable** — use alongside vmware-monitor or vmware-aiops as needed
+
+## Version Compatibility
+
+| vSphere | Support | Notes |
+|---------|---------|-------|
+| 8.0 | Full | vSAN SDK built into pyVmomi 8.0.3+ |
+| 7.0 | Full | All storage APIs work |
+| 6.7 | Compatible | iSCSI + datastore features work; vSAN limited |
+
+## Safety
+
+| Feature | Description |
+|---------|-------------|
+| Read-heavy | 6/11 tools are read-only |
+| Input validation | IP addresses and ports validated before iSCSI operations |
+| Audit logging | All operations logged to `~/.vmware-storage/audit.log` |
+| No VM operations | Cannot create, delete, or modify VMs |
+| Credential safety | Passwords only from environment variables, never config files |
+
+## License
+
+[MIT](LICENSE)

vmware_storage-1.2.0/README.md

@@ -0,0 +1,128 @@
+<!-- mcp-name: io.github.zw008/vmware-storage -->
+# VMware Storage
+
+[English](README.md) | [中文](README-CN.md)
+
+Domain-focused VMware vSphere storage management: datastores, iSCSI, vSAN.
+
+> **Part of the VMware MCP Skills family:**
+>
+> | Skill | Scope | Tools |
+> |-------|-------|:-----:|
+> | **vmware-monitor** (read-only) | Inventory, health, alarms, events | 8 |
+> | **vmware-aiops** (full ops) | VM lifecycle, deployment, guest ops, plans | 33 |
+> | **vmware-storage** (this) | Datastores, iSCSI, vSAN | 11 |
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+## Quick Install
+
+```bash
+# Via PyPI
+uv tool install vmware-storage
+
+# Or pip
+pip install vmware-storage
+```
+
+## Configuration
+
+```bash
+mkdir -p ~/.vmware-storage
+cp config.example.yaml ~/.vmware-storage/config.yaml
+# Edit with your vCenter/ESXi credentials
+
+echo "VMWARE_MY_VCENTER_PASSWORD=your_password" > ~/.vmware-storage/.env
+chmod 600 ~/.vmware-storage/.env
+
+# Verify
+vmware-storage doctor
+```
+
+## MCP Tools (11)
+
+| Category | Tools | Type |
+|----------|-------|------|
+| Datastore | `list_all_datastores`, `browse_datastore`, `scan_datastore_images`, `list_cached_images` | Read |
+| iSCSI | `storage_iscsi_enable`, `storage_iscsi_status`, `storage_iscsi_add_target`, `storage_iscsi_remove_target`, `storage_rescan` | Read/Write |
+| vSAN | `vsan_health`, `vsan_capacity` | Read |
+
+## CLI
+
+```bash
+# Datastore
+vmware-storage datastore list
+vmware-storage datastore browse datastore01
+vmware-storage datastore scan-images datastore01
+
+# iSCSI
+vmware-storage iscsi status esxi-01
+vmware-storage iscsi enable esxi-01
+vmware-storage iscsi add-target esxi-01 192.168.1.100
+vmware-storage iscsi remove-target esxi-01 192.168.1.100
+vmware-storage iscsi rescan esxi-01
+
+# vSAN
+vmware-storage vsan health Cluster-Prod
+vmware-storage vsan capacity Cluster-Prod
+
+# Diagnostics
+vmware-storage doctor
+```
+
+## MCP Server
+
+```bash
+# Run directly
+python -m mcp_server
+
+# Or via Docker
+docker compose up -d
+```
+
+### Agent Configuration
+
+Add to your AI agent's MCP config:
+
+```json
+{
+  "mcpServers": {
+    "vmware-storage": {
+      "command": "vmware-storage-mcp",
+      "env": {
+        "VMWARE_STORAGE_CONFIG": "~/.vmware-storage/config.yaml"
+      }
+    }
+  }
+}
+```
+
+## Why a Separate Skill?
+
+`vmware-aiops` has 33 MCP tools — too heavy for local LLMs (7B-14B). By splitting storage into its own skill:
+
+- **11 tools** — fits comfortably in small model context windows
+- **Domain-focused** — storage admins get only what they need
+- **Composable** — use alongside vmware-monitor or vmware-aiops as needed
+
+## Version Compatibility
+
+| vSphere | Support | Notes |
+|---------|---------|-------|
+| 8.0 | Full | vSAN SDK built into pyVmomi 8.0.3+ |
+| 7.0 | Full | All storage APIs work |
+| 6.7 | Compatible | iSCSI + datastore features work; vSAN limited |
+
+## Safety
+
+| Feature | Description |
+|---------|-------------|
+| Read-heavy | 6/11 tools are read-only |
+| Input validation | IP addresses and ports validated before iSCSI operations |
+| Audit logging | All operations logged to `~/.vmware-storage/audit.log` |
+| No VM operations | Cannot create, delete, or modify VMs |
+| Credential safety | Passwords only from environment variables, never config files |
+
+## License
+
+[MIT](LICENSE)

vmware_storage-1.2.0/RELEASE_NOTES.md

@@ -0,0 +1,39 @@
+# Release Notes
+
+## v1.2.0 (2026-03-22)
+
+### Initial Release / 首次发布
+
+Domain-focused VMware storage skill, split from vmware-aiops for lighter context and better local model compatibility.
+
+从 vmware-aiops 中按领域拆分出的存储管理 skill，更轻量，对本地模型更友好。
+
+### Datastore Management / 数据存储管理
+
+- `list_all_datastores` — List all datastores with capacity, usage %, accessibility
+- `browse_datastore` — Browse files in any datastore directory
+- `scan_datastore_images` — Find OVA, ISO, OVF, VMDK across datastores
+- `list_cached_images` — Query local image registry with filters
+
+### iSCSI Configuration / iSCSI 配置
+
+- `storage_iscsi_enable` — Enable software iSCSI adapter on ESXi hosts
+- `storage_iscsi_status` — Show adapter status and configured targets
+- `storage_iscsi_add_target` — Add iSCSI send target with auto-rescan
+- `storage_iscsi_remove_target` — Remove target with auto-rescan
+- `storage_rescan` — Force rescan all HBAs and VMFS volumes
+
+### vSAN Monitoring / vSAN 监控
+
+- `vsan_health` — Cluster health summary with disk group details
+- `vsan_capacity` — Total/used/free capacity with usage percentage
+
+### Infrastructure / 基础设施
+
+- CLI (`vmware-storage`) with typer — datastore/iscsi/vsan subcommands
+- MCP server (11 tools) via stdio transport
+- Docker one-command launch
+- `vmware-storage doctor` — 6-check environment diagnostics
+- Audit logging (JSON Lines)
+
+**PyPI**: `uv tool install vmware-storage==1.2.0`

vmware_storage-1.2.0/config.example.yaml

@@ -0,0 +1,10 @@
+targets:
+  - name: my-vcenter
+    host: vcenter.example.com
+    username: administrator@vsphere.local
+    type: vcenter
+    port: 443
+    verify_ssl: false
+
+notify:
+  webhook_url: ""

vmware_storage-1.2.0/docker-compose.yml

@@ -0,0 +1,8 @@
+services:
+  vmware-storage-mcp:
+    build: .
+    volumes:
+      - ~/.vmware-storage:/root/.vmware-storage:ro
+    environment:
+      - VMWARE_STORAGE_CONFIG=/root/.vmware-storage/config.yaml
+    stdin_open: true

vmware_storage-1.2.0/mcp_server/__main__.py

@@ -0,0 +1,5 @@
+"""Entry point for: python -m mcp_server"""
+
+from mcp_server.server import main
+
+main()

vmware_storage-1.2.0/mcp_server/server.py

@@ -0,0 +1,286 @@
+"""MCP server wrapping VMware Storage operations.
+
+This module exposes VMware vSphere datastore browsing, iSCSI configuration,
+and vSAN health/capacity tools via the Model Context Protocol (MCP) using
+stdio transport.
+
+Tool categories
+---------------
+* **Read-only**: list_all_datastores, browse_datastore, scan_datastore_images,
+  list_cached_images, storage_iscsi_status, vsan_health, vsan_capacity
+* **Write**: storage_iscsi_enable, storage_iscsi_add_target,
+  storage_iscsi_remove_target, storage_rescan
+
+Security considerations
+-----------------------
+* Credentials are loaded from environment variables / .env file.
+* Transport: Uses stdio transport (local only); no network listener.
+* iSCSI operations modify host storage configuration; confirmation recommended.
+
+Source: https://github.com/zw008/VMware-Storage
+License: MIT
+"""
+
+from __future__ import annotations
+
+import logging
+import os
+from pathlib import Path
+from typing import Any
+
+from mcp.server.fastmcp import FastMCP
+
+from vmware_storage.config import load_config
+from vmware_storage.connection import ConnectionManager
+from vmware_storage.ops import datastore_browser
+from vmware_storage.ops.inventory import list_datastores
+from vmware_storage.ops.iscsi_config import (
+    add_iscsi_target,
+    enable_software_iscsi,
+    get_iscsi_status,
+    remove_iscsi_target,
+    rescan_storage,
+)
+from vmware_storage.ops.vsan import get_vsan_capacity, get_vsan_health
+from vmware_storage.notify.audit import AuditLogger
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger("vmware-storage.mcp")
+
+mcp = FastMCP("VMware Storage")
+
+_audit = AuditLogger()
+
+# ---------------------------------------------------------------------------
+# Connection management (lazy-init singleton)
+# ---------------------------------------------------------------------------
+
+_conn_mgr: ConnectionManager | None = None
+
+
+def _get_conn_mgr() -> ConnectionManager:
+    global _conn_mgr
+    if _conn_mgr is None:
+        config_path = os.environ.get("VMWARE_STORAGE_CONFIG")
+        config = load_config(Path(config_path) if config_path else None)
+        _conn_mgr = ConnectionManager(config)
+    return _conn_mgr
+
+
+def _get_connection(target: str | None = None):
+    return _get_conn_mgr().connect(target)
+
+
+# ---------------------------------------------------------------------------
+# Datastore tools
+# ---------------------------------------------------------------------------
+
+
+@mcp.tool()
+def list_all_datastores(target: str | None = None) -> list[dict]:
+    """List all datastores with capacity, usage percentage, and accessibility.
+
+    Args:
+        target: Optional vCenter/ESXi target name from config.
+    """
+    si = _get_connection(target)
+    return list_datastores(si)
+
+
+@mcp.tool()
+def browse_datastore(
+    ds_name: str,
+    path: str = "",
+    pattern: str = "*",
+    target: str | None = None,
+) -> list[dict]:
+    """Browse files in a datastore directory.
+
+    Args:
+        ds_name: Datastore name.
+        path: Subdirectory path (empty for root).
+        pattern: Glob pattern to filter files (e.g. "*.ova", "*.iso").
+        target: Optional vCenter/ESXi target name from config.
+    """
+    si = _get_connection(target)
+    return datastore_browser.browse_datastore(si, ds_name, path=path, pattern=pattern)
+
+
+@mcp.tool()
+def scan_datastore_images(
+    ds_name: str,
+    path: str = "",
+    target: str | None = None,
+) -> list[dict]:
+    """Scan a datastore for deployable images (OVA, ISO, OVF, VMDK).
+
+    Args:
+        ds_name: Datastore name.
+        path: Subdirectory path (empty for root).
+        target: Optional vCenter/ESXi target name from config.
+    """
+    si = _get_connection(target)
+    return datastore_browser.scan_images(si, ds_name, path=path)
+
+
+@mcp.tool()
+def list_cached_images(
+    image_type: str | None = None,
+    datastore: str | None = None,
+) -> list[dict]:
+    """List images from the local cache registry.
+
+    Args:
+        image_type: Filter by extension (e.g. "ova", "iso").
+        datastore: Filter by datastore name.
+    """
+    return datastore_browser.list_images(image_type=image_type, datastore=datastore)
+
+
+# ---------------------------------------------------------------------------
+# iSCSI tools
+# ---------------------------------------------------------------------------
+
+
+@mcp.tool()
+def storage_iscsi_enable(
+    host_name: str,
+    target: str | None = None,
+) -> str:
+    """Enable the software iSCSI adapter on an ESXi host.
+
+    Args:
+        host_name: ESXi host name.
+        target: Optional vCenter/ESXi target name from config.
+    """
+    si = _get_connection(target)
+    result = enable_software_iscsi(si, host_name)
+    _audit.log(target=target or "default", operation="iscsi_enable",
+               resource=host_name, parameters={"host_name": host_name}, result=result)
+    return result
+
+
+@mcp.tool()
+def storage_iscsi_status(
+    host_name: str,
+    target: str | None = None,
+) -> dict:
+    """Get iSCSI adapter status and configured send targets.
+
+    Args:
+        host_name: ESXi host name.
+        target: Optional vCenter/ESXi target name from config.
+    """
+    si = _get_connection(target)
+    return get_iscsi_status(si, host_name)
+
+
+@mcp.tool()
+def storage_iscsi_add_target(
+    host_name: str,
+    address: str,
+    port: int = 3260,
+    target: str | None = None,
+) -> str:
+    """Add an iSCSI send target to an ESXi host and rescan storage.
+
+    Args:
+        host_name: ESXi host name.
+        address: iSCSI target IP address.
+        port: iSCSI target port (default 3260).
+        target: Optional vCenter/ESXi target name from config.
+    """
+    si = _get_connection(target)
+    result = add_iscsi_target(si, host_name, address, port)
+    _audit.log(target=target or "default", operation="iscsi_add_target",
+               resource=host_name,
+               parameters={"host_name": host_name, "address": address, "port": port},
+               result=result)
+    return result
+
+
+@mcp.tool()
+def storage_iscsi_remove_target(
+    host_name: str,
+    address: str,
+    port: int = 3260,
+    target: str | None = None,
+) -> str:
+    """Remove an iSCSI send target from an ESXi host and rescan storage.
+
+    Args:
+        host_name: ESXi host name.
+        address: iSCSI target IP address.
+        port: iSCSI target port (default 3260).
+        target: Optional vCenter/ESXi target name from config.
+    """
+    si = _get_connection(target)
+    result = remove_iscsi_target(si, host_name, address, port)
+    _audit.log(target=target or "default", operation="iscsi_remove_target",
+               resource=host_name,
+               parameters={"host_name": host_name, "address": address, "port": port},
+               result=result)
+    return result
+
+
+@mcp.tool()
+def storage_rescan(
+    host_name: str,
+    target: str | None = None,
+) -> str:
+    """Rescan all HBAs and VMFS volumes on an ESXi host.
+
+    Args:
+        host_name: ESXi host name.
+        target: Optional vCenter/ESXi target name from config.
+    """
+    si = _get_connection(target)
+    result = rescan_storage(si, host_name)
+    _audit.log(target=target or "default", operation="storage_rescan",
+               resource=host_name, parameters={"host_name": host_name}, result=result)
+    return result
+
+
+# ---------------------------------------------------------------------------
+# vSAN tools
+# ---------------------------------------------------------------------------
+
+
+@mcp.tool()
+def vsan_health(
+    cluster_name: str,
+    target: str | None = None,
+) -> dict:
+    """Get vSAN cluster health summary and disk groups.
+
+    Args:
+        cluster_name: Name of the vSAN-enabled cluster.
+        target: Optional vCenter/ESXi target name from config.
+    """
+    si = _get_connection(target)
+    return get_vsan_health(si, cluster_name)
+
+
+@mcp.tool()
+def vsan_capacity(
+    cluster_name: str,
+    target: str | None = None,
+) -> dict:
+    """Get vSAN capacity overview (total/used/free) for a cluster.
+
+    Args:
+        cluster_name: Name of the vSAN-enabled cluster.
+        target: Optional vCenter/ESXi target name from config.
+    """
+    si = _get_connection(target)
+    return get_vsan_capacity(si, cluster_name)
+
+
+# ---------------------------------------------------------------------------
+# Entry point
+# ---------------------------------------------------------------------------
+
+
+def main():
+    """Run the MCP server."""
+    mcp.run(transport="stdio")