🛠️ Tools Reference¶

Complete reference of all tools available in EasyPanel MCP.

📋 Tools by Category¶

EasyPanel MCP provides 25+ tools organized into 7 categories:

Category	Tools	Description
📦 Services	10 tools	Manage Docker services + intelligent logs
🚀 Deployments	4 tools	Control deployments and versions
🌐 Networks	3 tools	Auto-discover network topology
📁 Projects	4 tools	Organize resources
📊 Monitoring	4 tools	Real-time system metrics
⚡ Scaling	2 tools	Vertical and auto-scaling
🔒 Security	3 tools	Domains and Git authentication

Total: 30 tools for complete infrastructure management with AI.

🎯 Tool Usage Pattern¶

All tools follow a consistent pattern:

Tool Definition Structure¶

{
  "name": "tool_name",
  "description": "What the tool does",
  "inputSchema": {
    "type": "object",
    "properties": {
      "parameter_name": {
        "type": "string|integer|boolean|object",
        "description": "Parameter description"
      }
    },
    "required": ["required_parameter"]
  }
}

Tool Call Format¶

{
  "method": "tools/call",
  "params": {
    "name": "tool_name",
    "arguments": {
      "parameter_name": "value"
    }
  }
}

Tool Response Format¶

{
  "success": true,
  "data": { ... },
  "message": "Human-readable message"
}

📦 Services Tools¶

Manage Docker services in EasyPanel.

`list_services`¶

List all services, optionally filtered by project.

Parameters: - project_id (optional): Filter by project

Example:

{
  "method": "tools/call",
  "params": {
    "name": "list_services",
    "arguments": {
      "project_id": "proj_123"
    }
  }
}

Response:

{
  "success": true,
  "data": [
    {
      "id": "svc_abc",
      "name": "api-service",
      "image": "nginx:latest",
      "status": "running"
    }
  ],
  "message": "Found 1 services"
}

`get_service`¶

Get detailed information about a specific service.

Parameters: - service_id (required): Service ID

Example:

{
  "name": "get_service",
  "arguments": {
    "service_id": "svc_abc123"
  }
}

`create_service`¶

Create a new service.

Parameters: - name (required): Service name - project_id (required): Project ID - image (required): Docker image - config (optional): Additional configuration

Example:

{
  "name": "create_service",
  "arguments": {
    "name": "my-api",
    "project_id": "proj_123",
    "image": "node:18-alpine",
    "config": {
      "ports": ["3000:3000"],
      "env": {"NODE_ENV": "production"}
    }
  }
}

`update_service`¶

Update service configuration.

Parameters: - service_id (required): Service ID - config (required): New configuration

Example:

{
  "name": "update_service",
  "arguments": {
    "service_id": "svc_abc",
    "config": {
      "replicas": 3
    }
  }
}

`delete_service`¶

Delete a service.

Parameters: - service_id (required): Service ID

`restart_service`¶

Restart a service.

Parameters: - service_id (required): Service ID

`get_service_logs`¶

Get service logs.

Parameters: - service_id (required): Service ID - lines (optional): Number of lines (default: 100)

🚀 Deployments Tools¶

Manage deployments and versions.

`list_deployments`¶

List all deployments.

Parameters: - project_id (optional): Filter by project

`get_deployment`¶

Get deployment details.

Parameters: - deployment_id (required): Deployment ID

`create_deployment`¶

Create a new deployment.

Parameters: - project_id (required): Project ID - service_id (required): Service ID - image (required): Docker image to deploy - config (optional): Additional configuration

Example:

{
  "name": "create_deployment",
  "arguments": {
    "project_id": "proj_123",
    "service_id": "svc_abc",
    "image": "myapp:v2.0.0",
    "config": {
      "strategy": "rolling"
    }
  }
}

`get_deployment_logs`¶

Get deployment logs.

Parameters: - deployment_id (required): Deployment ID

🌐 Networks Tools¶

Manage Docker networks including internal isolated networks.

`list_networks`¶

List all networks.

Parameters: None

`create_network`¶

Create a new network.

Parameters: - name (required): Network name - internal (optional): Isolated network (default: false) - driver (optional): Network driver (default: "overlay")

Example - Create Internal Network:

{
  "name": "create_network",
  "arguments": {
    "name": "database-net",
    "internal": true,
    "driver": "overlay"
  }
}

Example - Create Public Network:

{
  "name": "create_network",
  "arguments": {
    "name": "public-net",
    "internal": false
  }
}

`delete_network`¶

Delete a network.

Parameters: - network_id (required): Network ID

📁 Projects Tools¶

Organize resources into projects.

`list_projects`¶

List all projects.

Parameters: None

`get_project`¶

Get project details.

Parameters: - project_id (required): Project ID

`create_project`¶

Create a new project.

Parameters: - name (required): Project name - description (optional): Project description

Example:

{
  "name": "create_project",
  "arguments": {
    "name": "production-app",
    "description": "Production environment for main application"
  }
}

`delete_project`¶

Delete a project.

Parameters: - project_id (required): Project ID

🔧 Tool Execution Examples¶

Example 1: Complete Deployment Flow¶

// 1. Create project
{
  "name": "create_project",
  "arguments": {
    "name": "my-app",
    "description": "My application"
  }
}

// 2. Create internal network
{
  "name": "create_network",
  "arguments": {
    "name": "my-app-internal",
    "internal": true
  }
}

// 3. Create database service
{
  "name": "create_service",
  "arguments": {
    "name": "postgres-db",
    "project_id": "proj_123",
    "image": "postgres:15",
    "config": {
      "networks": ["my-app-internal"],
      "env": {
        "POSTGRES_PASSWORD": "secret"
      }
    }
  }
}

// 4. Create API service
{
  "name": "create_service",
  "arguments": {
    "name": "api-service",
    "project_id": "proj_123",
    "image": "myapp/api:latest",
    "config": {
      "ports": ["8080:8080"],
      "env": {
        "DATABASE_URL": "postgres://postgres:secret@postgres-db:5432/app"
      }
    }
  }
}

Example 2: Service Management¶

// List all services
{
  "name": "list_services"
}

// Get specific service
{
  "name": "get_service",
  "arguments": {
    "service_id": "svc_abc"
  }
}

// Get logs
{
  "name": "get_service_logs",
  "arguments": {
    "service_id": "svc_abc",
    "lines": 50
  }
}

// Restart service
{
  "name": "restart_service",
  "arguments": {
    "service_id": "svc_abc"
  }
}

📊 Response Codes¶

Success Response¶

{
  "success": true,
  "data": { ... },
  "message": "Operation completed successfully"
}

Error Response¶

{
  "success": false,
  "error": "Error description"
}

📊 Monitoring Tools¶

Real-time system and service monitoring.

`get_system_stats`¶

Get system statistics (CPU, memory, disk, network).

Example:

{
  "name": "get_system_stats",
  "arguments": {}
}

Response:

{
  "success": true,
  "data": {
    "cpuInfo": {"usedPercentage": 45, "count": 4},
    "memInfo": {"usedMemPercentage": 52, "totalMemMb": 16000},
    "diskInfo": {"usedPercentage": 10, "totalGb": 300},
    "network": {"inputMb": 1200, "outputMb": 3400}
  },
  "message": "System stats retrieved"
}

`get_service_stats`¶

Get service-specific statistics.

Parameters: None (returns all service stats)

`health_check`¶

Check if EasyPanel API is healthy and accessible.

Example:

{
  "name": "health_check",
  "arguments": {}
}

Response:

{
  "success": true,
  "data": true,  // true = healthy
  "message": "EasyPanel API is healthy"
}

`get_server_ip`¶

Get the server's public IP address.

Example:

{
  "name": "get_server_ip",
  "arguments": {}
}

Response:

{
  "success": true,
  "data": "203.0.113.42",
  "message": "Server IP retrieved"
}

⚡ Scaling Tools¶

Vertical and automatic scaling based on resource usage.

`scale_service`¶

Manually scale service resources (CPU/Memory).

Parameters: - service_id (required): Service to scale - cpu (optional): New CPU cores (e.g., 2, 4, 8) - memory (optional): New memory in MB (e.g., 4096, 8192)

Example:

{
  "name": "scale_service",
  "arguments": {
    "service_id": "svc_abc",
    "cpu": 4,
    "memory": 8192
  }
}

`auto_scale_service`¶

Automatically scale service based on resource thresholds.

Parameters: - service_id (required): Service to scale - cpu_threshold (optional): CPU % to trigger scaling (default: 80) - memory_threshold (optional): Memory % to trigger (default: 80) - max_cpu (optional): Maximum CPU cores (default: 8) - max_memory (optional): Maximum memory MB (default: 16384)

Example:

{
  "name": "auto_scale_service",
  "arguments": {
    "service_id": "svc_abc",
    "cpu_threshold": 80,
    "memory_threshold": 80
  }
}

Behavior: - Checks current CPU and memory usage - If usage > threshold, doubles resources (up to max) - Returns scaling decision and applied changes

🔒 Security Tools¶

Domain management and Git authentication.

`list_domains`¶

List all domains.

Parameters: - service_id (optional): Filter by service

`create_domain`¶

Create a new domain for a service.

Parameters: - name (required): Domain name (e.g., api.example.com) - service_id (optional): Service to attach domain to

Example:

{
  "name": "create_domain",
  "arguments": {
    "name": "api.myapp.com",
    "service_id": "svc_abc"
  }
}

`get_public_key`¶

Get Git public key for repository authentication.

Example:

{
  "name": "get_public_key",
  "arguments": {}
}

Response:

{
  "success": true,
  "data": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC7...",
  "message": "Public key retrieved"
}

🆘 Error Handling¶

Common Errors¶

Error	Cause	Solution
`Service not found`	Invalid service ID	Check service ID exists
`Project not found`	Invalid project ID	Verify project exists
`Connection refused`	EasyPanel unreachable	Check URL and network
`Unauthorized`	Invalid API key	Regenerate API key
`Timeout`	Request timeout	Increase `EASYPANEL_TIMEOUT`

Services Tools - Detailed service management
Deployments Tools - Deployment management
Networks Tools - Network configuration
Projects Tools - Project organization
Advanced Features - Security, scaling, monitoring
AI Agents Integration - Connect AI agents

🛠️ Master all tools! Choose a category to learn more.

🛠️ Tools Reference¶

📋 Tools by Category¶

🎯 Tool Usage Pattern¶

Tool Definition Structure¶

Tool Call Format¶

Tool Response Format¶

📦 Services Tools¶

list_services¶

get_service¶

create_service¶

update_service¶

delete_service¶

restart_service¶

get_service_logs¶

🚀 Deployments Tools¶

list_deployments¶

get_deployment¶

create_deployment¶

get_deployment_logs¶

🌐 Networks Tools¶

list_networks¶

create_network¶

delete_network¶

📁 Projects Tools¶

list_projects¶

get_project¶

create_project¶

delete_project¶

🔧 Tool Execution Examples¶

Example 1: Complete Deployment Flow¶

Example 2: Service Management¶

📊 Response Codes¶

Success Response¶

Error Response¶

📊 Monitoring Tools¶

get_system_stats¶

get_service_stats¶

health_check¶

get_server_ip¶

⚡ Scaling Tools¶

scale_service¶

auto_scale_service¶

🔒 Security Tools¶

list_domains¶

create_domain¶

get_public_key¶

🆘 Error Handling¶

Common Errors¶

📚 Related Documentation¶

`list_services`¶

`get_service`¶

`create_service`¶

`update_service`¶

`delete_service`¶

`restart_service`¶

`get_service_logs`¶

`list_deployments`¶

`get_deployment`¶

`create_deployment`¶

`get_deployment_logs`¶

`list_networks`¶

`create_network`¶

`delete_network`¶

`list_projects`¶

`get_project`¶

`create_project`¶

`delete_project`¶

`get_system_stats`¶

`get_service_stats`¶

`health_check`¶

`get_server_ip`¶

`scale_service`¶

`auto_scale_service`¶

`list_domains`¶

`create_domain`¶

`get_public_key`¶