邮件管理协议服务器

Zapmail MCP Server是一个为Zapmail API提供的模型上下文协议服务器,通过自然语言实现域名管理、邮箱操作和数据导出功能,支持与AI助手如Claude的交互。

  • by dsouzaalan
  • JavaScript
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 dsouzaalan/zapmail-mcp

使用说明

Zapamail MCP服务器

Zapmail API的模型上下文协议(MCP)服务器,提供对域管理、邮箱操作和导出的自然语言访问。该软件包使像Claude这样的人工智能助手能够通过自然语言命令与Zapamail进行交互。

特性

  • 完整的Zapmail API覆盖范围(46多种工具)
  • 自然语言命令处理
  • 从API文档生成动态工具
  • 对Reachinbox、Instantly、Smartlead、Reply.io和CSV的导出支持
  • 带TTL的缓存系统
  • 速率限制和错误处理
  • 多工作空间支持
  • MCP与Claude Desktop和Cursor的集成

先决条件

  • Node.js 18+
  • Zapmail API密钥
  • MCP兼容客户端(克劳德桌面、光标等)
  • 可选:用于增强自然语言处理的OpenAI API密钥

安装

选项1:使用npx(推荐)

无需安装-直接使用npx运行:

npx zapmail-mcp

选项2:全局安装

全局安装以实现持久访问:

npm install -g zapmail-mcp

MCP配置

适用于克劳德桌面

创建或更新 claude_desktop_config.json:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json 窗户: %APPDATA%\Claude\claude_desktop_config.json

使用npx(推荐):

{
  "mcpServers": {
    "zapmail": {
      "command": "npx",
      "args": ["zapmail-mcp"],
      "env": {
        "ZAPMAIL_API_KEY": "your-zapmail-api-key"
      }
    }
  }
}

使用全局安装:

{
  "mcpServers": {
    "zapmail": {
      "command": "zapmail-mcp",
      "args": [],
      "env": {
        "ZAPMAIL_API_KEY": "your-zapmail-api-key"
      }
    }
  }
}

对于光标

添加到光标MCP设置中:

使用npx(推荐):

{
  "mcpServers": {
    "zapmail": {
      "command": "npx",
      "args": ["zapmail-mcp"],
      "env": {
        "ZAPMAIL_API_KEY": "your-zapmail-api-key"
      }
    }
  }
}

使用全局安装:

{
  "mcpServers": {
    "zapmail": {
      "command": "zapmail-mcp",
      "args": [],
      "env": {
        "ZAPMAIL_API_KEY": "your-zapmail-api-key"
      }
    }
  }
}

快速开始

  1. 获取您的Zapmail API密钥:

    • 注册地址: Zapamail
    • 导航到API设置
    • 生成新的API密钥
  2. 配置您的MCP客户端:

    • 选择您喜欢的MCP客户端(Claude Desktop或Cursor)
    • 将上述配置JSON添加到MCP设置中
    • 替换 your-zapmail-api-key 使用您的实际API密钥
  3. 测试连接:

    • 打开您的MCP客户端
    • 尝试使用自然语言命令,如:
      • “列出我的所有Zapamail工作区”
      • “显示我的域名”
      • “检查example.com是否可供购买”

可用工具

核心管理工具

  • set_context -设置工作区和提供程序上下文
  • wallet_balance -获取钱包余额
  • list_workspaces -列出所有工作区
  • list_domains -列出工作区中的域
  • check_domain_availability -检查域可用性
  • purchase_domains -购买域名(钱包优先)
  • create_mailboxes_for_zero_domains -在空域上创建邮箱
  • add_third_party_account -添加第三方导出帐户
  • call_endpoint -调用任何Zapamail端点
  • generate_usernames -生成邮箱用户名
  • generate_name_pairs -生成名称对
  • generate_domains -生成基于AI的领域建议
  • check_domain_availability_batch -批量域可用性检查
  • plan_and_execute -自然语言计划和执行
  • get_server_info -获取服务器信息

系统管理工具

  • get_metrics -获取系统指标和性能数据
  • clear_cache -清除系统缓存
  • health_check -系统健康检查

高级邮箱工具

  • bulk_update_mailboxes -批量更新邮箱
  • search_mailboxes -使用高级筛选器搜索邮箱

导出系统工具

  • get_export_info -获取导出系统信息
  • get_export_scenario -获取导出场景说明
  • validate_export_request -验证导出请求参数
  • export_guidance -获取出口指导和最佳实践

API文档工具

  • get_api_info -获取全面的API端点信息
  • search_api_endpoints -按关键字搜索API端点
  • get_api_scenarios -获取常见的API使用场景
  • get_api_best_practices -获取API最佳实践和建议
  • generate_api_examples -生成API使用示例

动态API工具

具有自动工具生成功能的所有API端点文档

自然语言命令

连接到MCP客户端后,您可以使用自然语言控制Zapmail:

工作区和域管理

  • “列出我的所有工作区”
  • “显示当前工作区中包含'lead'的域”
  • “检查leadconnectlab.com是否可用2年”
  • “如果可能的话,使用钱包购买leadconnectlab.com和outreachprohub.com一年”

邮箱管理

  • “在没有邮箱的域中创建3个邮箱”
  • “为我设置100个邮箱并连接到Instantly.ai”
  • “用新名称更新所有邮箱”

出口业务

  • “将所有邮箱导出到收件箱”
  • “立即将邮箱导出到”
  • “将邮箱导出为CSV”
  • “导出特定邮箱”
  • “从leadconnectio.com域导出邮箱”

第三方集成

  • “连接收件箱帐户”
  • “立即添加凭据”
  • “链接智能铅帐户”
  • “安装程序reply.io集成”

配置

环境变量

变量 描述 默认值 必填
ZAPMAIL_API_KEY 您的Zapmail API密钥 - 是
ZAPMAIL_WORKSPACE_KEY 默认工作区ID - 否
ZAPMAIL_SERVICE_PROVIDER 电子邮件提供商(谷歌/微软) 谷歌 否
ZAPMAIL_LOG_LEVEL 日志记录级别(调试/信息/警告/错误) 信息 否
ZAPMAIL_MAX_RETRIES 最大重试次数 3 否
ZAPMAIL_TIMEOUT_MS 请求超时(毫秒) 30000 否
ZAPMAIL_ENABLE_CACHE 启用响应缓存 true 否
ZAPMAIL_ENABLE_METRICS 启用性能指标 true 否
ZAPMAIL_RATE_LIMIT_DELAY 速率限制延迟(毫秒) 1000 否
OPENAI_API_KEY 用于增强NLP的OpenAI API密钥 - 否

使用示例

域操作

检查域可用性

在克劳德桌面或光标中:

"Check if example.com is available for 1 year"

购买域名

在克劳德桌面或光标中:

"Buy example.com and test.com for 1 year using wallet if possible"

邮箱管理

在空域上创建邮箱

在克劳德桌面或光标中:

"Create 5 mailboxes on domains that have zero mailboxes"

批量更新邮箱

在克劳德桌面或光标中:

"Update all mailboxes with new names and details"

出口业务

导出到Reachinbox

在克劳德桌面或光标中:

"Connect my Reachinbox account and export all mailboxes"

获取出口指导

在克劳德桌面或光标中:

"Help me export 100 mailboxes to Reachinbox"

复杂的工作流程

多步操作

在克劳德桌面或光标中:

"Buy example.com and test.com, create 5 mailboxes on each, and export to reachinbox"

工作空间管理

在克劳德桌面或光标中:

"Show me all my workspaces and switch to the one with the most domains"

系统监控

健康检查

在克劳德桌面或光标中:

"Check the health of my Zapmail connection"

获取指标

在克劳德桌面或光标中:

"Show me performance metrics for my Zapmail operations"

故障排除

MCP连接问题

1.未找到MCP服务器

问题:“找不到zapamil-mcp命令”或“找不到此npx-zapamil-mcp” 解决方案:

对于npx用法:

# Test npx directly
npx zapmail-mcp --version

# If npx fails, try with explicit package version
npx zapmail-mcp@latest --version

# Get help information
npx zapmail-mcp --help

对于全局安装:

# Install the package globally
npm install -g zapmail-mcp

# Verify installation
zapmail-mcp --version

2.MCP客户端未检测到服务器

问题:Zapamail工具未出现在克劳德桌面/光标中 解决方案:

  • 重新启动MCP客户端(克劳德桌面/光标)
  • 检查MCP配置文件语法
  • 验证配置中的命令路径

3.API关键问题

问题:“ZAPMAIL_API_KEY未配置” 解决方案:

  • 在MCP配置中设置环境变量:
{
  "mcpServers": {
    "zapmail": {
      "command": "npx",
      "args": ["zapmail-mcp"],
      "env": {
        "ZAPMAIL_API_KEY": "your-api-key"
      }
    }
  }
}
  • 或全局设置:
export ZAPMAIL_API_KEY="your-api-key"

4.工作空间上下文问题

问题:从错误的工作区获取数据 解决方案:在MCP配置中设置工作区:

{
  "env": {
    "ZAPMAIL_WORKSPACE_KEY": "your-workspace-id"
  }
}

性能问题

1.响应时间慢

问题:MCP操作耗时过长 解决方案:

  • 启用缓存: ZAPMAIL_ENABLE_CACHE="true"
  • 增加速率限制延迟: ZAPMAIL_RATE_LIMIT_DELAY="2000"
  • 检查您的互联网连接

2.费率限制

问题:“请求太多”错误 解决方案:增加MCP配置中的速率限制延迟:

{
  "env": {
    "ZAPMAIL_RATE_LIMIT_DELAY": "2000"
  }
}

调试模式

启用调试日志记录以进行详细的故障排除:

{
  "env": {
    "ZAPMAIL_LOG_LEVEL": "DEBUG"
  }
}

健康检查

测试您的MCP连接: 在克劳德桌面或光标中:

"Check the health of my Zapmail connection"

常见MCP配置错误

1.JSON语法无效

问题:MCP客户端无法加载配置 解决方案:使用JSON验证器验证JSON配置

2.错误的命令路径

问题:MCP客户端中“找不到命令” 解决方案:使用完整路径或确保 zapmail-mcp 在你的路径中

3.环境变量未加载

问题:API密钥未传递到MCP服务器 解决方案:使用 env MCP配置中的部分,而不是全局环境变量

MCP入门

步骤1:安装软件包

选项A:使用npx(推荐) 无需安装-只需使用npx:

npx zapmail-mcp

选项B:全局安装

npm install -g zapmail-mcp

步骤2:获取您的Zapmail API密钥

  1. 注册地址: Zapamail
  2. 导航到API设置
  3. 生成新的API密钥
  4. 记下您的工作区ID(可选但推荐)

步骤3:配置MCP客户端

选择您偏好的MCP客户端,并按照上述配置步骤进行操作。

步骤4:测试连接

打开MCP客户端,尝试一个简单的命令:

  • “列出我的Zapamail工作区”
  • “显示我的域名”

步骤5:探索高级功能

连接后,您可以:

  • 通过自然语言管理域和邮箱
  • 导出到第三方平台
  • 设置复杂的自动化工作流程
  • 监控性能和健康状况

包裹信息

命令行选项

MCP服务器支持以下命令行选项:

版本信息

npx zapmail-mcp --version
# or
npx zapmail-mcp -v

帮助信息

npx zapmail-mcp --help
# or
npx zapmail-mcp -h

支持

有关支持和问题:

  • 检查上面的故障排除部分
  • 查看MCP配置示例
  • 通过健康检查测试你的联系
  • 启用调试日志记录以获取详细的错误信息
  • 访问 GitHub存储库 用于问题和讨论

贡献

  1. 分叉存储库
  2. 创建要素分支
  3. 进行更改
  4. 如果适用,添加测试
  5. 提交拉取请求

许可证

此项目根据MIT许可证获得许可-有关详细信息,请参阅许可证文件。


由以下材料制成❤️ Zapamail社区