项目简介

Smartlead MCP 服务器是一个后端应用,它通过 Model Context Protocol (MCP) 将 Smartlead 的邮件营销、线索管理、送达率优化等丰富功能封装为标准的工具 (Tools),供兼容 MCP 的 AI 助手、大型语言模型 (LLM) 客户端或自动化平台(如 n8n)调用。

它允许 LLM 客户端以结构化的方式访问 Smartlead 数据和执行操作,扩展了 AI 在邮件营销领域的应用能力。服务器支持通过标准输入/输出 (STDIO) 和服务器发送事件 (SSE) 等多种传输协议进行通信。

项目的可用功能取决于您的 Smartlead API 密钥和 Jean Technologies 许可证等级(免费版、基础版、高级版)。

主要功能点

该 MCP 服务器提供以下主要功能分类下的工具集,具体数量和可用性取决于许可证等级:

  • 邮件营销活动管理: 创建、更新、列出、获取和删除邮件营销活动,管理活动日程和设置,保存和获取活动序列,以及获取活动相关的统计数据。
  • 销售线索管理: 列出、获取、添加、更新和删除销售线索,更新线索状态,并支持批量导入线索。
  • 活动统计: 获取邮件营销活动的各类统计数据,包括按日期、按线索和按邮箱的统计,以及邮箱预热数据。
  • 送达率优化 (Smart Delivery): 执行邮件送达率测试,获取测试报告(按服务商、按地区、按发件箱),检查 SPF/DKIM/rDNS,管理黑名单,获取邮箱摘要和文件夹信息等。
  • Webhook 管理: 获取、添加、更新和删除与邮件营销活动关联的 Webhook。
  • 客户管理: 添加和获取客户信息(通常用于机构或代理账户)。
  • 智能发件箱 (Smart Senders): 获取域名供应商列表,搜索可用域名,自动生成邮箱以及下单购买域名和邮箱。

安装步骤

  1. 确保您的系统已安装 Node.js 和 npm (或 yarn, pnpm)。
  2. 通过 npm 安装本服务器作为全局命令:
    npm install -g smartlead-mcp-server-local
    或者,您也可以使用 'npx' 直接运行,无需全局安装:
    npx smartlead-mcp-server-local ...
  3. 配置必要的密钥。您需要提供 Smartlead API Key 和 Jean License Key。您可以通过以下命令进行交互式配置并保存到 '.env' 文件:
    npx smartlead-mcp-server-local config
    或者,您也可以手动创建 '.env' 文件在运行目录下,并添加以下内容(替换为您的实际密钥):
    SMARTLEAD_API_KEY="your_smartlead_api_key_here"
    JEAN_LICENSE_KEY="your_jean_license_key_here"
    # 您可能还需要配置许可服务器地址,如果提供商有要求
    # LICENSE_SERVER_URL="https://your-license-server.com"

服务器配置 (供 MCP 客户端使用)

MCP 客户端需要知道如何启动并连接到此服务器。通常,这涉及在客户端的配置文件中指定服务器的启动命令、参数和必要的环境变量。

例如,在一个 MCP 客户端的配置中,您可能需要指定如下信息(具体格式取决于客户端):

  • 服务器名称 (Server Name): 给服务器起一个标识名称,例如 'smartlead'。
  • 启动命令 (Command): 启动服务器的可执行文件路径或命令。对于此项目,可以使用 'npx' 命令。
    • 对于 STDIO 模式 (推荐用于多数 AI 助手): 指定命令为 'npx'。
    • 对于 SSE/HTTP 模式 (用于 n8n 等): 指定命令为 'npx'。
  • 命令参数 (Args): 传递给启动命令的参数。
    • 对于 STDIO 模式: 指定参数为 '["smartlead-mcp-server-local", "start"]'。
    • 对于 SSE/HTTP 模式: 指定参数为 '["smartlead-mcp-server-local", "sse", "--port", "3000"]' (端口号可自定义)。
  • 环境变量 (Env): 如果您选择不使用 '.env' 文件,或者想通过客户端传入密钥,可以在这里设置 'SMARTLEAD_API_KEY' 和 'JEAN_LICENSE_KEY' 环境变量。

MCP 客户端将使用这些信息在需要时自动启动服务器进程并与之建立连接。

基本使用方法

一旦 MCP 服务器通过上述配置启动并运行(由您的 MCP 客户端自动管理),LLM 客户端就可以开始与其交互:

  1. 客户端首先发送 'initialize' 请求,服务器会返回其能力声明(例如,支持 'listTools' 和 'callTool')。
  2. 客户端可以发送 'listTools' 请求,获取服务器当前许可证等级下可用的所有工具列表及其详细描述(包括输入参数的 Schema)。
  3. 基于用户指令或自动化流程,客户端可以根据工具列表选择合适的工具,并发送 'callTool' 请求,附带相应的参数来调用 Smartlead 的功能(例如,调用 'smartlead_list_campaigns' 工具来获取您的所有邮件营销活动列表)。
  4. 服务器执行相应的 Smartlead API 调用,并将结果(成功或错误)以 JSON-RPC 响应的形式返回给客户端。

重要提示: 您无需手动启动服务器进程。兼容的 MCP 客户端会在需要时根据配置信息自动为您启动和管理服务器。

信息

分类

商业系统