Skip to main content

MCP server for AWS EBS volume initialization

Project description

EBS Initialization MCP Server

A Model Context Protocol (MCP) server for automating AWS EBS volume initialization. This server provides tools to initialize EBS volumes attached to EC2 instances using AWS Systems Manager.

Features

  • 🔍 Volume Discovery: Automatically discover all EBS volumes attached to an EC2 instance
  • 🚀 Automated Initialization: Initialize volumes using fio (recommended) or dd
  • ⏱️ Smart Time Estimation: Predict completion time with parallel processing simulation
  • 📊 Progress Monitoring: Check initialization status and view detailed logs
  • Cancellation Support: Cancel ongoing initialization with process cleanup
  • 🌐 Multi-Region Support: Works across all AWS regions
  • 🔒 Secure Execution: Uses AWS Systems Manager for secure remote execution

Installation

Using uvx (Recommended)

# Run directly without installation (latest version)
uvx ebs-initializer-mcp@latest

# Or run specific version
uvx ebs-initializer-mcp==0.6.0

# Install globally
uv tool install ebs-initializer-mcp

# Upgrade to latest version
uvx --upgrade ebs-initializer-mcp

From GitHub

uvx --from git+https://github.com/username/ebs-init-mcp.git ebs-mcp-server

Usage

As MCP Server

Add to your MCP configuration (mcp_config.json):

{
  "mcpServers": {
    "ebs-initializer": {
      "command": "uvx",
      "args": ["ebs-initializer-mcp@latest"],
      "env": {
        "AWS_REGION": "us-west-2"
      }
    }
  }
}

Available Tools

  1. get_instance_volumes: Get all EBS volumes attached to an instance
  2. initialize_all_volumes: Initialize all volumes on an instance (parallel processing with time estimation)
  3. initialize_volume_by_id: Initialize a specific volume by its volume ID
  4. check_initialization_status: Monitor initialization progress and view detailed logs
  5. cancel_initialization: Cancel ongoing initialization with complete process cleanup

Example Usage with Claude Code

"Initialize all EBS volumes for instance i-1234567890abcdef0 using fio"
"Initialize volume vol-1234567890abcdef0 using fio"
"Check the status of the newly attached volume vol-abcdef1234567890"
"Cancel the initialization command 12345678-1234-1234-1234-123456789012"

The MCP server will:

  1. Discover all attached EBS volumes and calculate estimated completion time
  2. Install fio on the target instance
  3. Run initialization commands in parallel with real-time throughput optimization
  4. Provide detailed status updates with progress logs
  5. Allow cancellation with complete process cleanup if needed

Prerequisites

  • AWS CLI configured with appropriate permissions
  • EC2 instances must have Systems Manager agent installed
  • Supported Operating Systems:
    • Amazon Linux 2
    • Amazon Linux 2023
    • Red Hat Enterprise Linux (RHEL)
    • Ubuntu (18.04, 20.04, 22.04, 24.04)
    • SUSE Linux Enterprise Server (SLES)
  • Required IAM permissions:
    • ec2:DescribeVolumes
    • ssm:SendCommand
    • ssm:GetCommandInvocation

AWS IAM Permissions

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ec2:DescribeVolumes",
                "ssm:SendCommand",
                "ssm:GetCommandInvocation"
            ],
            "Resource": "*"
        }
    ]
}

Configuration

Environment Variables

The server automatically detects AWS region from environment variables:

# Option 1: AWS_DEFAULT_REGION (preferred)
export AWS_DEFAULT_REGION=ap-northeast-2

# Option 2: AWS_REGION (also supported)  
export AWS_REGION=ap-northeast-2

Priority order:

  1. AWS_DEFAULT_REGION environment variable
  2. AWS_REGION environment variable
  3. Fallback to us-east-1

MCP Configuration

{
  "mcpServers": {
    "ebs-initializer": {
      "command": "uvx",
      "args": ["ebs-initializer-mcp@latest"],
      "env": {
        "AWS_DEFAULT_REGION": "ap-northeast-2"
      }
    }
  }
}

Development

git clone <repository>
cd ebs-init-mcp
pip install -e ".[dev]"

# Run tests
pytest

# Format code
black src/
ruff check src/

License

MIT License

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

ebs_initializer_mcp-0.6.5.tar.gz (51.5 kB view details)

Uploaded Source

Built Distribution

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

ebs_initializer_mcp-0.6.5-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file ebs_initializer_mcp-0.6.5.tar.gz.

File metadata

  • Download URL: ebs_initializer_mcp-0.6.5.tar.gz
  • Upload date:
  • Size: 51.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for ebs_initializer_mcp-0.6.5.tar.gz
Algorithm Hash digest
SHA256 ab607567ec3f6bd80346b79b2ac9c99b5f7c2ad48ca2a89bcc28f9d907ccda06
MD5 8af8195d50b936098a548d4d84c84186
BLAKE2b-256 e4001ea2ee9c25cb97e0f840f1446e977254bbe6c6166675eb32ba8f00624526

See more details on using hashes here.

File details

Details for the file ebs_initializer_mcp-0.6.5-py3-none-any.whl.

File metadata

File hashes

Hashes for ebs_initializer_mcp-0.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5d7900d6fe80c3631cd542dcc476668e8ee4d50bb27fac6de4903f1cf26ecfed
MD5 7f19275ec9dfbaa9846f50d69950872b
BLAKE2b-256 6753107fcadcd0109745038d45a4decdf475ee88b2db19467937dc180772fb22

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