Omnisend MCP 服务器
与 Omnisend API V5 集成的模型上下文协议 (MCP) 服务器，用 TypeScript 编写。
版本： 2.2.0
特征
- 联系人管理（列出、创建、获取、更新）
- 产品管理（列出、创建、获取、替换、删除）
- 事件追踪
- 产品类别管理
- 基于游标的分页支持，包含下一个/上一个 URL 和限制/偏移信息
2.2.0 版变更
- 将代码库重构为更加模块化的结构
- 实施特定领域的模块（联系人、产品、类别、事件）
- 将代码组织到逻辑目录中（/types、/filters、/api-resources、/resources、/tools）
- 在 ping 工具中使服务器版本动态化
- 在 API 请求中添加了更好的错误处理
- 通过桶导出提高代码的可维护性
- 删除冗余和重复的代码
2.1.0 版变更
- 已更新至@modelcontextprotocol/sdk v1.11.0
- 改进了整个应用程序的错误处理
- 增强 API 稳定性，提供更清晰的错误消息
- 添加了请求超时配置以防止挂起连接
- 修复了 SSE 与 MCP Inspector 的连接问题
- 优化控制台输出以兼容 MCP 客户端
- 在 MCP 响应中添加了基于光标的分页上下文（下一个/上一个 URL、限制/偏移）
2.0.0 版变更
- 将整个代码库迁移到 TypeScript
- 根据最新规范更新了 MCP 资源结构
- 为所有 API 响应和请求添加了适当的类型声明
- 使用类型异常改进错误处理
- 增强代码组织和可维护性
安装
建筑
要编译 TypeScript 代码：
以开发模式运行
对于自动重新加载的开发：
配置
使用您的 Omnisend API 密钥在根目录中创建一个.env文件：
OMNISEND_API_KEY=your_api_key_here
OMNISEND_API_URL=https://api.omnisend.com/v5
用法
要启动 MCP 服务器：
与 MCP 服务器交互
MCP 服务器旨在与支持模型上下文协议 (MCP) 的客户端配合使用。以下是与其交互的方式：
VS Code 集成
为了与 VS Code 配合使用，我们提供了一个配置文件.vscode/mcp.json 。安装了相应 MCP 扩展的 VS Code 可以与此服务器通信。
人工智能助手
像 Claude 这样支持 MCP 的 AI 助手可以与该服务器通信以访问 Omnisend 数据并执行操作。
与 Claude Desktop 一起使用
要将此 MCP 服务器与 Claude Desktop 一起使用：
- 从官方网站下载并安装Claude Desktop。
- 确保你的系统上已安装 Node.js。你可以运行以下命令来验证：如果未安装 Node.js，请从nodejs.org下载。
- 打开计算机上的 Claude 菜单并选择“设置...”
- 单击“设置”窗格左侧栏中的“开发人员”，然后单击“编辑配置”
- 这将打开您的 Claude Desktop 配置文件。将文件内容替换为以下配置或添加以下配置：
{
"mcpServers": {
"omnisend": {
"command": "node",
"args": [
"/path/to/dist/index.js"
],
"env": {
"OMNISEND_API_KEY": "your_api_key_here"
}
}
}
}
your_api_key_here替换为您的实际 Omnisend API 密钥。 - 保存配置文件并重新启动Claude Desktop。
- 重新启动后，您应该会在输入框的右下角看到一个锤子图标。
- 单击锤子图标即可查看可用的 Omnisend 工具。
- 您现在可以要求 Claude 执行如下操作：
- “在 Omnisend 中列出我最近的联系人”
- “在我的 Omnisend 目录中创建新产品”
- “将客户事件发送至 Omnisend”
自定义 MCP 客户端
您可以使用@modelcontextprotocol/sdk库开发自定义客户端：
import { McpClient } from '@modelcontextprotocol/sdk/client/mcp';
import { ProcessClientTransport } from '@modelcontextprotocol/sdk/client/process';
const transport = new ProcessClientTransport(serverProcess);
const client = new McpClient(transport);
// Connect to the server
await client.connect();
// Execute tools
const result = await client.executeTool("listContacts", { limit: 10 });
API 文档
有关 Omnisend API 的更多信息，请参阅官方文档。
执照
该项目根据 Apache License 2.0 获得许可 - 有关详细信息，请参阅LICENSE文件。