Whm MCP Server

🚀 WHM 管理控制面板（MCP）

WHM 管理控制面板（MCP）是一個基於 Node.js 的服務器應用程序，它能夠連接到 WHM（Web Host Manager）服務器，實現賬戶管理和服務管理功能。該應用實現了模型上下文協議（MCP），使得 AI 助手（如 Claude）可以與 WHM API 進行交互，為服務器管理提供了更智能、便捷的方式。

✨ 主要特性

• 賬戶管理：支持賬戶的創建、修改、掛起和終止操作。
• 服務器信息和統計：可查看服務器的相關信息和統計數據。
• 服務器更新和維護：方便進行服務器的更新和維護工作。
• SSL 證書管理：對 SSL 證書進行有效管理。
• 備份管理：實現服務器數據的備份管理。
• 電子郵件賬戶管理：可對電子郵件賬戶進行管理。
• 域名管理：支持域名的相關管理操作。
• 安全特性：具備一定的安全保障機制。
• MCP 協議實現：支持 AI 助手集成，便於與 WHM API 交互。

📦 安裝指南

1. 克隆倉庫。
2. 安裝依賴：

   npm install
   

3. 配置 .env 文件，輸入您的 WHM 服務器詳細信息：

   # WHM 服務器配置
   WHM_SERVER=your-server-domain.com
   WHM_PORT=2087
   WHM_USERNAME=root
   WHM_API_TOKEN=your-api-token-here
   
   # MCP 服務器配置
   PORT=3000
   NODE_ENV=development
   LOG_LEVEL=info
   
   # API 認證
   API_KEY=your-secret-api-key-here
   

4. 啟動服務器：

   npm start
   

開發環境使用：

npm run dev

📚 詳細文檔

MCP 服務器配置

要將此 MCP 服務器與 AI 助手（如 Claude 在 Cursor 中）一起使用，您需要在 mcp.json 文件中添加以下配置：

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

MCP 實現細節

此服務器使用 HTTP 服務器發送事件（SSE）作為傳輸機制實現模型上下文協議。實現遵循標準的 JSON - RPC 2.0 格式的所有消息，幷包括：

• /sse 端點用於建立持久連接。
• /messages 端點用於接收和響應客戶端請求。
• 主動 connection/ready 和 tools/ready 通知。
• 規範化錯誤處理，帶有適當的錯誤代碼。

MCP 架構允許 AI 助手通過明確定義的工具與 WHM 功能安全交互，參數模式創建語言模型與服務器管理功能之間的安全橋樑。

可用 MCP 工具

該 MCP 服務器通過以下工具公開 WHM 功能：

賬戶管理

• 查看所有賬戶：列出所有用戶賬戶。
• 創建新賬戶：添加新的用戶賬戶。
• 刪除指定賬戶：移除特定的用戶賬戶。

服務器信息和統計

• 獲取服務器狀態：返回當前服務器運行狀態。
• 查看資源使用情況：顯示 CPU、內存等資源使用詳情。

API 文檔

完整的 API 文檔請訪問 官方文檔鏈接。

🔧 技術細節

此服務器使用 HTTP 服務器發送事件（SSE）作為傳輸機制實現模型上下文協議。實現遵循標準的 JSON - RPC 2.0 格式的所有消息，包含 /sse 和 /messages 兩個端點，分別用於建立持久連接和接收響應客戶端請求，同時有主動通知和規範化錯誤處理。MCP 架構讓 AI 助手能通過明確定義的工具與 WHM 功能安全交互，參數模式在語言模型與服務器管理功能間搭建了安全橋樑。

💻 使用示例

基礎用法

使用以下命令克隆倉庫並安裝依賴：

git clone <倉庫地址>
npm install

配置 .env 文件後啟動服務器：

npm start

高級用法

在開發環境中，使用以下命令啟動服務器，支持熱更新：

npm run dev

使用隨附的示例客戶端測試 MCP 服務器：

npm run example

這將運行一個簡單的測試客戶端，連接到 MCP 服務器，請求可用工具，並執行樣本命令。

🔒 安全注意事項

⚠️ 重要提示

• 保護 API 令牌：確保 WHM_API_TOKEN 不被洩露，避免未授權訪問。
• 部署 HTTPS：在生產環境中啟用 SSL 證書以加密通信。
• 定期更新軟件：保持服務器和相關組件的最新狀態，防範已知漏洞。