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 based on volume size and throughput
  • ๐Ÿ“Š Real-time Progress Tracking: Visual progress bars with accurate percentage and remaining time
  • โŒ Cancellation Support: Cancel ongoing initialization with complete process cleanup
  • ๐Ÿค– AI Agent Optimized: Text-based responses optimized for AI agent compatibility
  • ๐ŸŒ Multi-Region Support: Works across all AWS regions including t2 instance type support
  • ๐Ÿ”’ Secure Execution: Uses AWS Systems Manager for secure remote execution
  • ๐Ÿ—๏ธ Modular Architecture: Clean, maintainable codebase with separated concerns

Installation

Using uvx (Recommended)

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

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

# 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 real-time progress tracking with visual progress bars and accurate percentages
  5. Return AI agent-optimized flat JSON structure for better compatibility
  6. Allow cancellation with complete process cleanup if needed

Progress Tracking

Version 0.6.7 introduces enhanced progress tracking optimized for AI agents:

Visual Progress Display

  • Real-time progress bars: [โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘] 50.0%
  • Accurate percentages: Based on initial time estimation and elapsed time
  • Remaining time calculation: Precise estimates of completion time

AI Agent Optimization

  • Flat JSON structure: Progress information at top-level fields for easy access
  • Priority field ordering: Most important progress data comes first
  • Simple message format: "๐Ÿ”„ 50.0% Complete..."

Response Structure

{
  "command_id": "...",
  "status": "InProgress",
  "execution_start_time": "2025-09-10 01:18:21.418000+00:00",
  "progress_percentage": 50.0,
  "progress_bar": "[โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘] 50.0%",
  "estimated_remaining_minutes": 5.2,
  "message": "๐Ÿ”„ 50.0% Complete..."
}

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"
      }
    }
  }
}

Architecture

Modular Design

The codebase is organized into focused modules for maintainability and reusability:

src/ebs_init_mcp/
โ”œโ”€โ”€ server.py           # MCP server and tool definitions (430 lines)
โ”œโ”€โ”€ aws_clients.py      # AWS client caching and management
โ”œโ”€โ”€ throughput.py       # EBS throughput calculation with t2โ†’t3 mapping
โ”œโ”€โ”€ estimation.py       # Time estimation algorithms
โ”œโ”€โ”€ initialization.py   # Command generation for volume initialization
โ”œโ”€โ”€ status.py          # Status checking and progress calculation
โ””โ”€โ”€ utils.py           # Utility functions and device mapping scripts

Time Estimation Logic

1. initialize_all_volumes (Parallel Initialization)

Algorithm: Simulates parallel processing with throughput sharing

# Step 1: Get instance EBS throughput (t2 types mapped to t3)
instance_throughput = get_instance_ebs_throughput(instance_type)

# Step 2: Collect volume data
volumes = [{'size_gb': size, 'max_throughput_mbps': vol_throughput}...]

# Step 3: Parallel simulation algorithm
while volumes_remaining:
    n = len(volumes_remaining)
    
    # Current throughput per volume (limited by bottleneck)
    throughput_per_vol = min(
        min_volume_throughput,           # Volume constraint
        instance_throughput / n          # Instance constraint รท parallel count
    )
    
    # Time to complete smallest volume
    smallest_size_gb = min(volumes_remaining)
    time_seconds = (smallest_size_gb * 1024 MB) / throughput_per_vol
    
    # Update remaining volumes and accumulate time
    total_time += time_seconds

Example: 3 volumes (100GB each), instance throughput 500MB/s, volume throughput 1000MB/s

  • Initial: 3 volumes ร— 166.7MB/s each = 10.2 minutes for smallest
  • After 1 completes: 2 volumes ร— 250MB/s each
  • After 2 complete: 1 volume ร— 500MB/s
  • Total: ~14 minutes

2. initialize_volume_by_id (Single Volume)

Algorithm: Simple throughput-limited calculation

# Step 1: Get throughput constraints
instance_throughput = get_instance_ebs_throughput(instance_type)
volume_throughput = volume.get('Throughput', 1000)

# Step 2: Calculate effective throughput (bottleneck)
effective_throughput = min(volume_throughput, instance_throughput)

# Step 3: Linear time calculation
estimated_minutes = (size_gb * 1024 MB) / effective_throughput / 60

Example: 100GB volume, t3.large (500MB/s), gp3 (1000MB/s)

  • Effective: min(1000, 500) = 500MB/s
  • Time: (100 ร— 1024) / 500 / 60 = 3.4 minutes

Instance Type Support

t2 Instance Handling: t2 types don't appear in describe-instance-types API, so they're automatically mapped to t3 equivalents:

  • t2.micro โ†’ t3.micro
  • t2.large โ†’ t3.large
  • etc.

This ensures accurate throughput calculation for all instance types.

Development

git clone <repository>
cd ebs-init-mcp

# Install dependencies
uv sync

# Run development server
AWS_REGION=ap-northeast-2 uv run mcp dev src/ebs_init_mcp/server.py

# Run tests
uv run pytest

# Format code
uv run ruff format src/
uv run 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.7.10.tar.gz (62.6 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.7.10-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ebs_initializer_mcp-0.7.10.tar.gz
  • Upload date:
  • Size: 62.6 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.7.10.tar.gz
Algorithm Hash digest
SHA256 4a9f8f01d16ee946d126b70ac0ee2ff01ba403c1f4166d08612dab0b4e3bf85a
MD5 5e029e8740d3f25028c9188a5fa5bf41
BLAKE2b-256 8e6db8a7f4e415597031981ce96fbf7658c5c3f727b5b68bbdb6f6032ae230ff

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ebs_initializer_mcp-0.7.10-py3-none-any.whl
Algorithm Hash digest
SHA256 9e27e6749a1aa288e27e49fb5844c500d47a355b7c05527b012008c65d18fe9f
MD5 328a96b5d1da53eeecfddf24a0d59833
BLAKE2b-256 278ecd9697a6b4444f03a1832cb34f9c421d3c9993bc42d5ca0c112cad54fbf3

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