Skip to main content

VAST Admin MCP Server - MCP server for VAST Data administration tasks

Project description

VAST Admin MCP Server

PyPI Version Python Version License

A Model Context Protocol (MCP) server for VAST Data administration. Enables AI assistants to interact with VAST clusters for monitoring, management, and data protection operations.

VAST Admin MCP Demo

Features

  • 🤖 Full MCP Integration - Native support for Claude Desktop, Cursor, VSCode, and other MCP clients
  • 🔧 Cluster Management - List and monitor VAST clusters, views, tenants, quotas, and more
  • 📊 Performance Metrics - Real-time performance data and graph generation
  • 🔐 Secure Credentials - Encrypted password storage using system keyring
  • 🛡️ API Whitelist - Security through endpoint and method restrictions
  • ✏️ Read-Write Mode - Optional write access for create operations (views, snapshots, quotas)
  • 🎨 Customizable - YAML-based templates for adding custom list functions

Installation

pip install vast-admin-mcp

Requirements:

  • Python 3.10+
  • jq command-line tool (for JSON transformations)

Installing jq

macOS:

brew install jq

Linux (Ubuntu/Debian):

sudo apt-get install jq

Linux (RHEL/CentOS):

sudo yum install jq

Quick Start

1. Configure VAST Cluster Connection

vast-admin-mcp setup

This will prompt you for:

  • Cluster address (IP, FQDN, or URL)
  • Username and password
  • Tenant name (if applicable)

2. Configure Your AI Assistant

Get setup instructions for your AI tool:

# For Cursor
vast-admin-mcp mcpsetup cursor

# For Claude Desktop
vast-admin-mcp mcpsetup claude-desktop

# For VSCode
vast-admin-mcp mcpsetup vscode

# For Windsurf
vast-admin-mcp mcpsetup windsurf

Note: Add --read-write as an argument in the config to enable create operations.

3. Start Using with Your AI Assistant

Example prompts:

List all VAST clusters
Show me all views on cluster1 with capacity information
Create a bandwidth and IOPS graph for cluster1 over the last hour
List all snapshots for view path /data/app1
Show me any critical alarms that haven't been acknowledged

CLI Usage

Test functions directly from the command line:

# List available commands
vast-admin-mcp list

# List clusters
vast-admin-mcp clusters

# List views with filters
vast-admin-mcp list views --cluster cluster1 --tenant mytenant

Read-Only vs Read-Write Mode

By default, the MCP server runs in read-only mode for safety:

  • ✅ All list/query operations
  • ✅ Performance monitoring
  • ✅ Viewing configurations
  • ❌ Create operations disabled

Enable read-write mode to allow:

  • ✅ Creating views
  • ✅ Creating snapshots and clones
  • ✅ Setting quotas
  • ✅ Creating view templates

Add --read-write to the MCP server configuration to enable write operations.

Available MCP Tools

List Tools

  • list_clusters_vast - Cluster information and status
  • list_views_vast - Views with capacity and protocols
  • list_tenants_vast - Tenant information and capacity
  • list_volumes_vast - NVMe volumes/namespaces
  • list_quotas_vast - Quota configurations
  • list_snapshots_vast - Snapshot information
  • list_alarms_vast - Active alarms and alerts
  • list_performance_vast - Performance metrics
  • And many more...

Create Tools (read-write mode only)

  • create_view_vast - Create new views
  • create_view_from_template_vast - Create from templates
  • create_snapshot_vast - Create snapshots
  • create_clone_vast - Clone from snapshots
  • create_quota_vast - Set quotas

Docker Support

Docker images are available for easy deployment:

# Using helper script
./vast-admin-mcp-docker.sh setup
./vast-admin-mcp-docker.sh list clusters

# Or with docker directly
docker run --rm -it \
  -v ~/.vast-admin-mcp:/root/.vast-admin-mcp \
  vast-admin-mcp:latest \
  vast-admin-mcp list clusters

See the full documentation for complete Docker setup instructions.

Configuration Files

  • Cluster Config: ~/.vast-admin-mcp/config.json
  • Template Customizations: ~/.vast-admin-mcp/mcp_list_template_modifications.yaml
  • View Templates: ~/.vast-admin-mcp/view_templates.json
  • Logs: ~/.vast-admin-mcp/vast_admin_mcp.log

Documentation

For comprehensive documentation, including:

  • Detailed installation instructions
  • Template customization guide
  • API whitelist configuration
  • Advanced Docker usage
  • Security best practices
  • Full prompt examples

Visit: https://github.com/vast-data/vast-admin-mcp#readme

Platform Support

  • ✅ macOS
  • ✅ Linux
  • ❌ Windows (not supported)

Community & Support

VAST Admin MCP Server welcomes questions, feedback, and feature requests. Join the conversation on https://community.vastdata.com/

License

Apache License 2.0 - See LICENSE for details.

Author

Haim Marko <haim.marko@vastdata.com>

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vast_admin_mcp-0.1.2.tar.gz (5.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vast_admin_mcp-0.1.2-py3-none-any.whl (152.1 kB view details)

Uploaded Python 3

File details

Details for the file vast_admin_mcp-0.1.2.tar.gz.

File metadata

  • Download URL: vast_admin_mcp-0.1.2.tar.gz
  • Upload date:
  • Size: 5.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.21

File hashes

Hashes for vast_admin_mcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 db5f50ddb7fe61f5b8e19f48717b232b64d2c6e773e9956fd6be372b8369b5a5
MD5 fdf661a9b2d8edbfceac8567352648db
BLAKE2b-256 d065d73f315daf4cb21f7553650280bf4a607900d3c461016feeb91e5266feee

See more details on using hashes here.

File details

Details for the file vast_admin_mcp-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: vast_admin_mcp-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 152.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.21

File hashes

Hashes for vast_admin_mcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9c68e3945c0bfafb365ee196e705810cdec5544a2b2a914634dca1ca1240ac75
MD5 a84a0ef28ee34744136bca94205c2ce8
BLAKE2b-256 0399fec97500d1b5822cb3802b15b26862cef27c706288c114331870f91cf340

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page