Whm MCP Server

🚀 WHM Management Control Panel (MCP)

A Node.js-based server application that connects to a WHM (Web Host Manager) server for account management and service management. This application implements the Model Context Protocol (MCP) to enable AI assistants (such as Claude) to interact with the WHM API.

🚀 Quick Start

The WHM Management Control Panel (MCP) is a Node.js application designed to connect with WHM servers. It simplifies account and service management and enables seamless interaction between AI assistants and the WHM API.

✨ Features

• Account management (create, modify, suspend, terminate)
• Server information and statistics
• Server updates and maintenance
• SSL certificate management
• Backup management
• Email account management
• Domain name management
• Security features
• MCP protocol implementation to support AI assistant integration

📦 Installation

1. Clone the repository.
2. Install dependencies:

   npm install
   

3. Configure the .env file and enter your WHM server details:

   # WHM server configuration
   WHM_SERVER=your-server-domain.com
   WHM_PORT=2087
   WHM_USERNAME=root
   WHM_API_TOKEN=your-api-token-here
   
   # MCP server configuration
   PORT=3000
   NODE_ENV=development
   LOG_LEVEL=info
   
   # API authentication
   API_KEY=your-secret-api-key-here
   

4. Start the server:

   npm start
   

For development environment use:

npm run dev

📚 Documentation

MCP Server Configuration

To use this MCP server with an AI assistant (such as Claude in Cursor), you need to add the following configuration to the mcp.json file:

{
  "mcpServers": {
    "whm": {
      "url": "http://your-server-address:3000/sse"
    }
  }
}

MCP Implementation Details

This server implements the Model Context Protocol using HTTP Server-Sent Events (SSE) as the transport mechanism. All messages follow the standard JSON-RPC 2.0 format and include:

• The /sse endpoint for establishing a persistent connection
• The /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 interact securely with WHM functions through well-defined tools. The parameter mode creates a secure bridge between the language model and server management functions.

Available MCP Tools

This MCP server exposes WHM functions through the following tools:

Account Management

• View all accounts: Lists all user accounts.
• Create a new account: Adds a new user account.
• Delete a specified account: Removes a specific user account.

Server Information and Statistics

• Get server status: Returns the current server running status.
• View resource usage: Displays details of resource usage such as CPU and memory.

API Documentation

For the complete API documentation, please visit Official Documentation Link.

⚠️ Important Note

1. Protect your API token: Ensure that the WHM_API_TOKEN is not leaked to prevent unauthorized access.
2. Deploy HTTPS: Enable an SSL certificate in the production environment to encrypt communications.
3. Update software regularly: Keep the server and related components up-to-date to prevent known vulnerabilities.

💻 Usage Examples

Testing the MCP Server

Use the included example client to test the MCP server:

npm run example

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