项目简介
Instantly MCP 服务器是一个强大的后端应用,专为大型语言模型(LLM)客户端设计,通过标准的Model Context Protocol (MCP) 协议,提供与Instantly.ai邮件营销平台深度集成的能力。它将Instantly.ai的API功能封装为易于LLM调用的工具,包括邮件活动管理、线索管理、账户管理、邮件操作和数据分析等,支持本地开发(Stdio)和远程部署(HTTP/SSE)两种连接方式。
主要功能点
- 邮件活动管理: 创建、列出、获取、更新、激活、暂停邮件营销活动,并进行时区验证和智能默认值填充。
- 线索管理: 创建、列出、获取、更新线索,批量导入线索,以及管理线索列表。
- 账户管理: 列出、创建、更新、暂停、恢复、删除邮件账户,启用/禁用邮件预热,并测试账户健康状况。
- 邮件操作: 列出、获取邮件详情,回复邮件(⚠️发送真实邮件),验证邮件可送达性,并统计未读邮件。
- 分析与报告: 获取活动表现指标、每日分析及邮件预热分析报告。
- 多传输协议支持: 支持Stdio(适用于本地Claude Desktop/Cursor IDE)和Streamable HTTP/SSE(适用于远程Web客户端)。
- 强大的验证和错误处理: 采用Zod进行参数验证,提供详细的错误信息和Instantly API错误映射。
- 会话管理与性能优化: 支持会话机制,并包含性能监控和速率限制功能。
安装步骤
- 确保您已安装Node.js (版本18或更高)。
- 克隆或下载仓库到本地。
- 打开终端,导航到项目根目录。
- 运行以下命令安装依赖并编译项目:
npm install npm run build
服务器配置 (供MCP客户端连接参考)
Instantly MCP 服务器支持本地和远程连接。您的MCP客户端需要配置服务器的启动命令或URL才能连接。以下是两种常见配置方式的参考信息:
本地连接 (例如: Claude Desktop): 如果您的MCP客户端在本地运行,通常需要提供服务器的启动命令和路径。
- 服务器名称 (server name): 'instantly'
- 启动命令 (command): 'node'
- 参数 (args): '/path/to/instantly-mcp/dist/index.js'
- 提示: 请将 '/path/to/instantly-mcp' 替换为 Instantly MCP 服务器项目在您本地文件系统中的实际路径。
- 环境变量 (env): 'INSTANTLY_API_KEY': '您的Instantly.ai API密钥'
- 提示: 强烈建议通过环境变量设置API密钥,以确保安全。
远程HTTP连接 (例如: Claude Web Custom Connector): 如果Instantly MCP 服务器已部署在远程,您的MCP客户端需要配置其URL和认证方式。
- 服务器名称 (server name): 'instantly'
- 服务器 URL (url): 'https://mcp.instantly.ai/mcp'
- 认证方式 (headers):
- 'Authorization': '您的Instantly.ai API密钥' (通常使用'Bearer '前缀,但此服务器直接接受密钥)
- 或者使用 'x-instantly-api-key': '您的Instantly.ai API密钥'
- 提示: 请将 '您的Instantly.ai API密钥' 替换为您的真实API密钥。
基本使用方法
- 本地运行:
在项目根目录设置您的Instantly.ai API密钥,然后启动服务器:
服务器将在 'http://localhost:3000/mcp' 上可用。export INSTANTLY_API_KEY="your-api-key-here" npm start - 通过MCP客户端连接: 根据您使用的MCP客户端(如Claude Desktop、Claude Web Custom Connector),按照上述“服务器配置”部分提供的信息进行配置,即可让LLM客户端调用Instantly MCP服务器提供的工具。例如,您可以使用LLM客户端发送请求以“列出我的账户”或“创建新的邮件营销活动”。
- 使用工具: 一旦连接成功,LLM客户端就可以通过发送MCP请求来调用服务器暴露的工具,例如调用 'list_accounts' 来获取您的邮件账户列表,或者调用 'create_campaign' 来创建一个新的邮件活动。
信息
分类
商业系统