Brevo MCP 服务器使用说明
项目简介
Brevo MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在为 Claude 等 LLM 客户端提供与 Brevo (Transactional Email and SMS Platform) API 交互的能力。通过该服务器,用户可以在 Claude 对话中直接使用 Brevo 的邮件发送和联系人管理功能,无需离开对话界面即可完成与 Brevo 相关的任务。
主要功能点
- 邮件管理:
- 发送事务性邮件:允许通过 Claude 发送预设或自定义的邮件内容。
- 追踪邮件事件:可以获取邮件的发送状态、送达情况等事件信息。
- 联系人管理:
- 创建和更新联系人:支持在 Brevo 中创建新的联系人或更新现有联系人的信息。
- 管理联系人属性:可以管理联系人的自定义属性,例如姓名、公司等。
安装步骤
-
克隆仓库 打开终端,执行以下命令克隆 Brevo MCP 服务器仓库到本地:
git clone https://github.com/apicolet/brevo-mcp.git cd brevo-mcp -
安装依赖 在仓库根目录下,使用 npm 安装项目依赖:
npm install -
构建项目 执行构建命令,将 TypeScript 代码编译为 JavaScript 代码:
npm run build构建完成后,编译后的文件将位于 'dist' 目录下。
服务器配置
要将 Brevo MCP 服务器配置到 MCP 客户端(如 Claude Desktop),您需要编辑客户端的配置文件(通常是 'config.json')。在 'MCPServers' 字段中添加以下配置信息。请根据您的实际情况修改 'apiKey' 的值。
{ "MCPServers": { "brevo": { "command": ["npx", "@apicolet/brevo-mcp/dist/server.js"], // 服务器启动命令,指向编译后的 server.js 文件 "config": { "apiKey": "YOUR_BREVO_API_KEY" // 替换为你的 Brevo API 密钥,请务必替换为您的 Brevo API 密钥 } } } }
配置参数说明:
- 'server name': 'brevo' (服务器名称,在客户端中用于标识和调用)
- 'command': '["npx", "@apicolet/brevo-mcp/dist/server.js"]' (服务器启动命令,使用 npx 运行编译后的 server.js 文件)
- 'config': 包含服务器所需的配置信息
- 'apiKey': '"YOUR_BREVO_API_KEY"' (Brevo API 密钥,用于服务器访问 Brevo API,请替换为您的真实 API 密钥)
基本使用方法
配置完成后,重启 MCP 客户端。在客户端中,您可以使用以下方式调用 Brevo MCP 服务器提供的工具:
// 示例 (在 Claude 中使用 JavaScript 代码块) // 获取联系人信息 (get_contact 工具) const contact = await mcp.brevo.get_contact({ identifier: "[email protected]" }); console.log(contact); // 发送邮件 (send_email 工具) const emailResult = await mcp.brevo.send_email({ to: [{ email: "[email protected]", name: "Recipient Name" }], subject: "来自 Claude 的邮件", htmlContent: "<h1>你好!</h1><p>这是一封来自 Claude 通过 Brevo MCP 发送的测试邮件。</p>" }); console.log(emailResult);
工具调用格式: 'mcp.服务器名称.工具名称(参数)'
请参考仓库 'README.md' 文件中 "Available Tools" 部分,了解可用的工具名称和参数。
信息
分类
通信与社交