JinDaGe - migadu-mcp MCP Details

article

README

🚀 Migadu MCP 服务器

Migadu MCP 服务器允许通过模型上下文协议（MCP），借助 AI 助手来控制你的 Migadu 电子邮件托管服务，为邮件管理带来更智能、便捷的体验。

🚀 快速开始

配置

将以下内容添加到你的 MCP 客户端配置中（例如 Claude Desktop）：

{
  "mcpServers": {
    "migadu": {
      "command": "uvx",
      "args": ["migadu-mcp"],
      "env": {
        "MIGADU_EMAIL": "admin@yourdomain.com",
        "MIGADU_API_KEY": "your-api-key",
        "MIGADU_DOMAIN": "yourdomain.com"
      }
    }
  }
}

从 Migadu 管理界面 > 我的账户 > API 密钥获取你的 API 密钥。

使用示例

配置完成后，你可以向 AI 助手提出如下请求：

"为 john@mydomain.com 创建一个新邮箱，邮箱所有者姓名为 John Smith"
"列出我域名下的所有邮箱"
"设置一个电子邮件别名 support@mydomain.com，将邮件转发到 team@mydomain.com"
"删除离职员工的邮箱：alice@mydomain.com, bob@mydomain.com"
"为 vacation@mydomain.com 设置自动回复"

✨ 主要特性

智能管理：无需手动操作网页界面，可通过 AI 助手完成邮箱的创建、删除、别名设置、转发规则配置等操作。
批量处理：支持高效的批量操作，提升管理效率。
多功能工具：提供邮箱管理、邮件路由、身份管理、高级路由和外部转发等多种工具。
结构化数据访问：通过资源 URI 访问结构化数据，方便快捷。

📦 安装指南

克隆仓库

git clone https://github.com/Michaelzag/migadu-mcp.git
cd migadu-mcp

安装依赖

uv sync --group dev

运行测试

uv run pytest

运行质量检查

uv run ruff format --check .
uv run ruff check .
uv run mypy migadu_mcp/

💻 使用示例

基础用法

配置完成后，使用 AI 助手进行基本的邮箱管理操作，如创建新邮箱：

"Create a new mailbox for john@mydomain.com with the name John Smith"

高级用法

使用批量操作功能，删除多个邮箱：

"Delete the mailboxes for employees who left: alice@mydomain.com, bob@mydomain.com"

📚 详细文档

可用工具

邮箱管理

list_mailboxes / list_my_mailboxes - 查看所有邮箱
get_mailbox / get_my_mailbox - 获取邮箱详细信息
create_mailbox / create_my_mailbox - 创建新邮箱
update_mailbox - 修改邮箱设置
delete_mailbox - 删除邮箱
bulk_delete_mailboxes - 批量删除邮箱
reset_mailbox_password - 重置邮箱密码
set_autoresponder - 配置自动回复消息

邮件路由

list_aliases / list_my_aliases - 查看电子邮件别名
create_alias - 设置邮件转发，无需创建邮箱
update_alias - 修改别名目标地址
delete_alias - 删除别名

身份管理

list_identities - 查看发件地址
create_identity - 添加额外的发件地址
update_identity - 修改身份权限
delete_identity - 删除身份

高级路由

list_rewrites - 查看基于模式的路由规则
create_rewrite - 设置通配符邮件路由
update_rewrite - 修改路由模式
delete_rewrite - 删除路由规则

外部转发

list_forwardings - 查看外部转发规则
create_forwarding - 将邮件转发到外部地址
update_forwarding - 修改转发设置
delete_forwarding - 删除转发规则

MCP 资源

通过以下资源 URI 访问结构化数据：

mailboxes://domain.com - 域名下的所有邮箱
mailbox://domain.com/username - 特定邮箱的详细信息
aliases://domain.com - 域名下的所有别名
identities://domain.com/mailbox - 邮箱的身份信息
forwardings://domain.com/mailbox - 邮箱的转发规则
rewrites://domain.com - 域名的重写规则

🔧 技术细节

自动处理 API 特性：服务器会自动处理 Migadu API 的一些特殊情况（例如成功删除操作返回 500 状态码）。
错误处理与进度报告：所有操作都包含适当的错误处理和进度报告。
可靠集成：基于 FastMCP 构建，确保可靠的 MCP 集成。
批量操作优化：支持批量操作，并采用智能批处理方式。

📄 许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。

migadu-mcp