SmartLead MCP Server
使用说明(Markdown 格式,帮助理解与快速上手)
-
项目简介
- 该仓库实现了一个基于 MCP(Model Context Protocol)的服务器端,用来把 SmartLead 的 API 功能封装成 MCP 工具,供 LLM 客户端通过 JSON-RPC 调用,包括 Campaign、Leads、Analytics、Email 账户、Webhook、Smart Delivery、Smart Senders 等模块的大量工具。
-
主要功能点
- MCP 服务端:接收和处理 MCP 客户端的 JSON-RPC 请求,返回标准化响应。
- 工具注册与分组:将各类 API 功能注册为 MCP 工具,分为必选工具、可选的高级工具以及管理员工具三类,支持灵活开启。
- 安全与连接:通过 API Key 认证 SmartLead API 接入,并支持重试、限流、日志等稳健特性。
- 多传输支持:当前实现以 StdIO 传输为核心,便于与 Claude Desktop、Windsurf 等客户端对接,未来可扩展为 SSE/WebSocket 等。
- 安装与部署友好:提供交互式安装入口,便于新用户快速搭建环境。
-
安装步骤
- 下载与依赖安装(通常通过 npm/yarn 安装仓库依赖)
- 设置环境变量:
- SMARTLEAD_API_KEY:SmartLead 的 API Key(必填)
- SMARTLEAD_BASE_URL:SmartLead API 基础地址,默认 https://server.smartlead.ai/api/v1(可选)
- SMARTLEAD_ADVANCED_TOOLS:启用高级工具,设置为 true/false(可选,默认 false)
- SMARTLEAD_ADMIN_TOOLS:启用管理员工具,设置为 true/false(可选,默认 false)
- 启动命令(示例):
- npx smartlead-mcp-by-leadmagic
- 安装模式(如需安装向导):npx smartlead-mcp-by-leadmagic install
-
服务器配置(JSON 配置,供 MCP 客户端了解如何连接) { "server_name": "smartlead-mcp-server", "command": "npx", "args": ["smartlead-mcp-by-leadmagic"], "notes": "启动该 MCP 服务器需要提供以下环境变量:SMARTLEAD_API_KEY、SMARTLEAD_BASE_URL(可选,默认 https://server.smartlead.ai/api/v1),SMARTLEAD_ADVANCED_TOOLS(true/false,默认 false),SMARTLEAD_ADMIN_TOOLS(true/false,默认 false)。MCP 客户端通过 JSON-RPC 与该服务器进行通信。" }
-
基本使用方法
- 启动后,MCP 服务器会监听并通过标准输出/标准输入进行通信,LLM 客户端可通过 JSON-RPC 调用注册的工具,例如获取 Campaign 信息、查询分析数据、管理 Leads、执行邮件发送等。
- 具体调用细节请参考客户端文档,使用服务器暴露的工具名称与参数结构进行调用,服务器会返回结构化的 JSON-RPC 响应信息或错误信息。