cPanel MCP 服务器

一个提供通过cPanel的UAPI管理电子邮件账户能力的MCP（模型上下文协议）服务器。此服务器能够实现自动化的电子邮件账户创建、删除、配置以及转发管理。

功能

• 电子邮件账户管理：创建、删除和列出电子邮件账户
• 密码管理：更改现有电子邮件账户的密码
• 配额管理：设置并更新邮箱存储限制
• 电子邮件转发：创建、删除和列出电子邮件转发器
• 客户端设置：获取电子邮件客户端配置设置
• 安全认证：使用cPanel API令牌进行安全访问

可用工具

电子邮件账户操作

• add_email_account(email, password, quota=0) - 创建一个新的电子邮件账户
• delete_email_account(email) - 删除现有的电子邮件账户
• list_email_accounts(domain) - 列出域的所有电子邮件账户
• change_password(email, new_password) - 更改电子邮件账户的密码
• update_quota(email, quota) - 更新邮箱大小限制
• get_email_settings(email) - 获取电子邮件客户端配置设置

电子邮件转发操作

• create_email_forwarder(email, destination) - 创建电子邮件转发器
• delete_email_forwarder(email, destination) - 删除电子邮件转发器
• list_email_forwarders(domain) - 列出域的所有转发器

要求

• Python 3.10 或更高版本
• 具有API访问权限的cPanel托管账户
• 有效的cPanel API令牌

安装

使用uv（推荐）

当使用uv时，无需安装。相反，您可以直接从Github使用uvx命令调用服务器

配置

服务器需要以下环境变量：

必需变量

• USERNAME - 您的cPanel用户名
• HOSTNAME - 您的cPanel主机名（例如，example.com或server.example.com）
• CPANEL_API_TOKEN - 您的cPanel API令牌

可选变量

• PORT - cPanel端口（默认：2083）
• SSL - 启用SSL连接（默认：true）

获取cPanel API令牌

1. 登录到您的cPanel账户
2. 导航至安全→管理API令牌
3. 点击创建令牌
4. 给它一个描述性名称（例如，“MCP服务器”）
5. 如有必要，设置适当的限制
6. 复制生成的令牌

使用方法

MCP客户端配置

将服务器添加到您的MCP客户端配置中（例如，Claude Desktop）：

{
  "mcpServers": {
    "cpanel-mcp": {
      "command": "uvx",
      "args": ["cpanel-mcp", "--repository", "https://github.com/ashrobertsdragon/cpanel-mcp"],
      "env": {
        "USERNAME": "your_cpanel_username",
        "HOSTNAME": "your.cpanel.hostname.com",
        "CPANEL_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

示例用法

一旦连接到MCP客户端，您可以使用自然语言命令：

• "创建新的电子邮件账户support@example.com，密码为SecurePass123"
• "列出example.com的所有电子邮件账户"
• "设置电子邮件转发，从info@example.com到admin@example.com"
• "更改user@example.com的密码为NewPassword456"
• "删除电子邮件账户temp@example.com"
• "更新sales@example.com的配额为1000 MB"

安全注意事项

• API令牌安全：切勿将API令牌提交到版本控制
• 环境变量：使用环境变量或安全的秘密管理
• 网络安全：确保您的cPanel服务器支持HTTPS（SSL）
• 密码策略：为电子邮件账户使用强密码

故障排除

常见问题

1. 身份验证错误

   • 验证您的API令牌是否正确且有效
   • 检查您的用户名是否与cPanel账户匹配
   • 确保主机名包括正确的域名/子域名

2. 连接问题

   • 验证主机名和端口是否正确
   • 检查SSL是否正确配置
   • 确保您的服务器允许API连接

3. 权限错误

   • 验证您的cPanel账户是否有电子邮件管理权限
   • 检查API令牌是否具有必要的权限

API参考

服务器使用cPanel的UAPI（统一API），涉及以下模块：

• 电子邮件模块：核心电子邮件账户管理
• 使用的函数：
  • add_pop - 创建电子邮件账户
  • del_pop - 删除电子邮件账户
  • list_pops - 列出电子邮件账户
  • passwd_pop - 更改密码
  • edit_pop_quota - 更新配额
  • get_client_settings - 获取电子邮件设置
  • add_forwarder - 创建转发器
  • delete_forwarder - 删除转发器
  • list_forwarders - 列出转发器

贡献

1. 分叉仓库
2. 创建功能分支
3. 进行修改
4. 如适用，添加测试
5. 提交拉取请求

许可证

本项目根据MIT许可证发布 - 查看LICENSE文件以获取详细信息。

支持

对于问题和疑问：

• 查看上面的故障排除部分
• 查阅cPanel的UAPI文档
• 在项目仓库中打开一个问题

更新日志

v0.1.0

• 初始发布
• 基本电子邮件账户管理
• 电子邮件转发支持
• 配额和密码管理
• MCP集成