ECS MCP Server

Version

v0.2.0

Overview

ECS MCP Server is a Model Context Protocol server that provides MCP clients (such as Claude Desktop) with the ability to interact with the Volcengine ECS service. It enables full-chain management of cloud instance resources based on natural language, supporting query operations for instances, images, regions, availability zones, available resources, and system events, thereby achieving efficient management of ECS resources.

Category

ECS

Features

• Query instance information
• Query event information
• Query region information
• Simple instance operations
• Event subscription management
• Instance console diagnostics

Available Tools

Since some interfaces have a lot of input parameters and return content, some uncommon content will cause too much context burden on llm. In order to avoid unnecessary token waste, ECS MCP Server only provides queries for common content.

Instance Management

• describe_instances: query instance list
• describe_images: query image list
• describe_instance_types: query instance type list
• describe_instance_type_families: query instance type family list
• describe_available_resource: query available resources
• start_instances: start instances
• renew_instance: renew instance

Region & Availability Zone

• describe_regions: query region list
• describe_zones: query availability zone list

System Events

• describe_system_events: query system events
• update_system_events: update system event status
• describe_event_types: query event type list

Event Subscription

• describe_subscriptions: query event subscription list

Instance Diagnostics

• get_console_output: get instance console output
• get_console_screenshot: get instance console screenshot

Usage Guide

Prerequisites

• Python 3.12+
• UV

Linux/macOS:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Installation

Clone the repository:

git clone git@github.com:volcengine/mcp-server.git

Usage

Start the server:

UV

cd mcp-server/server/mcp_server_ecs
uv run mcp-server-ecs

# Start with streamable-http mode (default is stdio)
uv run mcp-server-ecs -t streamable-http

Use a client to interact with the server:

Trae | Cursor ｜ Claude Desktop | Cline | ...

Configuration

Environment Variables

The following environment variables are available for configuring the MCP server:

Environment Variable	Description	Default Value
VOLCENGINE_ACCESS_KEY	Volcengine account ACCESSKEY	-
VOLCENGINE_SECRET_KEY	Volcengine account SECRETKEY	-
VOLCENGINE_REGION	Volcengine resource region	-
VOLCENGINE_ENDPOINT	Volcengine endpoint	-
MCP_SERVER_PORT	MCP server listening port	8000

For example, set these environment variables before starting the server:

export VOLCENGINE_ACCESS_KEY={ak}
export VOLCENGINE_SECRET_KEY={sk}
export VOLCENGINE_REGION={region}
export VOLCENGINE_ENDPOINT={endpoint}
export MCP_SERVER_PORT=8000

Run with uvx

Specify version from PyPI or mirror source

{
    "mcpServers": {
        "mcp-server-ecs": {
            "command": "uvx",
            "args": [
            "--from",
            "mcp-server-ecs>=0.2.0",
            "mcp-server-ecs"
          ],
            "env": {
                "VOLCENGINE_ACCESS_KEY": "",
                "VOLCENGINE_SECRET_KEY": "",
                "VOLCENGINE_REGION": ""
            }
        }
    }
}

{
    "mcpServers": {
        "mcp-server-ecs": {
            "command": "uvx",
            "args": [
            "--from",
            "git+https://github.com/volcengine/mcp-server#subdirectory=server/mcp_server_ecs",
            "mcp-server-ecs"
          ],
            "env": {
                "VOLCENGINE_ACCESS_KEY": "",
                "VOLCENGINE_SECRET_KEY": "",
                "VOLCENGINE_REGION": "",
                "VOLCENGINE_ENDPOINT": "",
                "MCP_SERVER_PORT": ""
            }
        }
    }
}

Examples

Cursor

License

volcengine/mcp-server is licensed under the MIT License.