HW

hosthobbit/whm-mcp-server

Developer tools
12 stars 8 forks Quality 71 Trend 22

MCP server that lets AI assistants like Claude manage WHM/cPanel servers: accounts, domains, services, updates

Overview

A Node.js server application that connects to a WHM (Web Host Manager) server for account administration and server management. This application implements the Model Context Protocol (MCP) to allow AI assistants like Claude to interact with WHM APIs. - Account Management (create, modify, suspend, terminate) - Server Information and Statistics - Server Updates and Maintenance - SSL Certificate Management - Backup Management - Email Account Management - Domain Management - Security Features - MCP Protocol Implementation for AI Assistant integration You need Node.js 18 or newer and a WHM API token. 1. Make a folder for the server and create a .env file in it: 2. Start the MCP server from that folder: Or clone this repository, run npm install, then npm run mcp. The MCP endpoint is http://localhost:3000/sse (the port comes from PORT; it is 4444 if PORT isn't set). Every request must send the API key, either as Authorization: Bearer or as X-API-Key: .

README

WHM Management Control Panel (MCP)

A Node.js server application that connects to a WHM (Web Host Manager) server for account administration and server management. This application implements the Model Context Protocol (MCP) to allow AI assistants like Claude to interact with WHM APIs.

Features

  • Account Management (create, modify, suspend, terminate)
  • Server Information and Statistics
  • Server Updates and Maintenance
  • SSL Certificate Management
  • Backup Management
  • Email Account Management
  • Domain Management
  • Security Features
  • MCP Protocol Implementation for AI Assistant integration

Quick start

You need Node.js 18 or newer and a WHM API token.

  1. Make a folder for the server and create a .env file in it:
    WHM_SERVER=your-server-domain.com
    WHM_PORT=2087
    WHM_USERNAME=root
    WHM_API_TOKEN=your-whm-api-token
    # Only if WHM is reached by IP or uses a self-signed certificate:
    # WHM_INSECURE_TLS=true
    
    PORT=3000
    # Required: the server refuses to start without it. Generate one with: openssl rand -hex 32
    API_KEY=your-long-random-api-key
    
  2. Start the MCP server from that folder:
    npx whm-mcp-server
    
    Or clone this repository, run npm install, then npm run mcp.

The MCP endpoint is http://localhost:3000/sse (the port comes from PORT; it is 4444 if PORT isn’t set).

MCP client configuration

Every request must send the API key, either as Authorization: Bearer or as X-API-Key: . Requests without it get 401 Unauthorized.

For clients that support remote servers with headers (for example Cursor), add this to mcp.json:

{
  "mcpServers": {
    "whm": {
      "url": "https://your-mcp-host:3000/sse",
      "headers": { "Authorization": "Bearer your-long-random-api-key" }
    }
  }
}

For clients that only run local commands (for example Claude Desktop), use the mcp-remote bridge:

{
  "mcpServers": {
    "whm": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://your-mcp-host:3000/sse", "--header", "Authorization: Bearer your-long-random-api-key"]
    }
  }
}

Run it behind HTTPS and a firewall: anyone with the key can manage the WHM server.

REST API (optional)

npm start runs a separate REST API (/api/..., see below), which also requires the API key, sent as an X-API-Key header.

MCP Implementation Details

This server implements the Model Context Protocol using HTTP Server-Sent Events (SSE) as the transport mechanism. The implementation follows the standard JSON-RPC 2.0 format for all messages and includes:

  • A /sse endpoint for establishing persistent connections
  • A /messages endpoint for receiving and responding to client requests
  • Proactive connection/ready and tools/ready notifications
  • Standardized error handling with appropriate error codes

The MCP architecture allows AI assistants to safely interact with WHM functionality through clearly defined tools with specific parameter schemas, creating a secure bridge between language models and server management functions.

Available MCP Tools

The MCP server exposes the following WHM functionality via tools:

Account Management

  • whm_list_accounts - List all WHM accounts
  • whm_create_account - Create a new cPanel account
  • whm_account_summary - Get account details
  • whm_suspend_account - Suspend a cPanel account
  • whm_unsuspend_account - Unsuspend a cPanel account
  • whm_terminate_account - Permanently delete an account

Server Management

  • whm_server_status - Get server status and system stats
  • whm_server_load - Get server load statistics
  • whm_service_status - Get status of server services
  • whm_restart_service - Restart a specific server service
  • whm_check_updates - Check for available updates
  • whm_start_update - Start server update process

Domain Management

  • whm_list_domains - List domains for an account
  • whm_add_domain - Add a domain to an account
  • whm_delete_domain - Remove a domain from an account

API Documentation

The API endpoints are organized by resource type:

  • /api/accounts - Account management operations
  • /api/server - Server information and operations
  • /api/domains - Domain management
  • /api/ssl - SSL certificate management
  • /api/backups - Backup management operations
  • /api/email - Email account management

For detailed API documentation, see the /docs endpoint after starting the server.

Security

This application requires WHM API credentials. Never share your .env file or expose your API tokens.

Security Best Practices

When using this MCP server for WHM administration, follow these security recommendations:

  1. API Token Protection: Keep your WHM API tokens secure and rotate them regularly. Create a WHM API token with only the privileges you need rather than using full root access where possible.
  2. Use TLS/SSL: Always deploy this server with HTTPS in production environments.
  3. Firewall Rules: Restrict access to the MCP server by IP address where possible.
  4. Regular Updates: Keep the WHM server updated with the latest security patches.
  5. Monitoring: Implement monitoring to detect unusual activity or unauthorized access attempts.
  6. Backup Strategy: Maintain regular backups of all server configurations and data.

Root vs. Site Compromises

Be aware of the distinction between site and root compromises:

  • A site compromise affects only specific websites, while a root compromise exposes the entire server.
  • In case of any compromise, restore from backups and identify the entry point of the attack.
  • For WHM security details, refer to the cPanel Security Best Practices.

Testing

You can test the MCP server using the included example client:

npm run example

This will run a simple test client that connects to the MCP server, requests the available tools, and executes a sample command.

License

ISC


About Host Hobbit

Built and maintained by Host Hobbit Ltd: managed WordPress hosting, WHM/cPanel and VPS administration, security hardening and AI automation for businesses in the UK.

Need help deploying this, or want something similar built for your business? Get in touch.

View the full README on GitHub

Install

npx -y mcp-remote https://your-mcp-host:3000/sse --header Authorization: Bearer your-long-random-api-key
New to MCP? Start with the mcpskill.org guide →

Configuration

{ "mcpServers": { "whm": { "url": "https://your-mcp-host:3000/sse", "headers": { "Authorization": "Bearer your-long-random-api-key" } } } }