Klaviyo API MCP Server

Klaviyo API MCP Server

site icon
2025.04.23 0
JavaScriptAPI 交互营销自动化数据管理交流协作
Klaviyo API MCP Server 是一个全面的模型上下文协议(MCP)服务器,用于与 Klaviyo 的 API 进行交互。该服务器提供了管理配置文件、列表、事件、活动、流程、模板、分段、指标、目录和数据隐私的工具和资源。
View on GitHub

Overview

基本能力

产品定位

Klaviyo API MCP Server 是一个用于与 Klaviyo API 交互的 MCP 服务器,提供全面的 API 功能覆盖和结构化工具。

核心功能

  • 完整的 Klaviyo API 功能覆盖
  • 使用 Zod 进行结构化工具和验证
  • API 参考文档资源
  • 错误处理和日志记录

适用场景

  • 管理 Klaviyo 用户配置文件
  • 创建和管理营销活动
  • 处理事件和指标数据
  • 管理目录和数据隐私

工具列表

Profiles

  • get_profiles: 获取配置文件列表(可选过滤)
  • get_profile: 通过 ID 获取特定配置文件
  • create_profile: 创建新配置文件
  • update_profile: 更新现有配置文件
  • delete_profile: 删除配置文件

Lists

  • get_lists: 获取所有列表
  • get_list: 通过 ID 获取特定列表
  • create_list: 创建新列表
  • update_list: 更新现有列表
  • delete_list: 删除列表
  • get_list_profiles: 获取列表中的配置文件
  • add_profiles_to_list: 将配置文件添加到列表
  • remove_profiles_from_list: 从列表中删除配置文件

Events

  • get_events: 获取事件列表(可选过滤)
  • get_event: 通过 ID 获取特定事件
  • create_event: 创建新事件

Campaigns

  • get_campaigns: 获取活动列表(可选过滤)
  • get_campaign: 通过 ID 获取特定活动
  • create_campaign: 创建新活动
  • update_campaign: 更新现有活动
  • delete_campaign: 删除活动
  • send_campaign: 发送活动

Flows

  • get_flows: 获取流程列表(可选过滤)
  • get_flow: 通过 ID 获取特定流程
  • update_flow_status: 更新流程状态

Templates

  • get_templates: 获取模板列表(可选过滤)
  • get_template: 通过 ID 获取特定模板
  • create_template: 创建新模板
  • update_template: 更新现有模板
  • delete_template: 删除模板
  • clone_template: 克隆现有模板
  • render_template: 使用上下文变量渲染模板

Segments

  • get_segments: 获取分段列表(可选过滤)
  • get_segment: 通过 ID 获取特定分段

Metrics

  • get_metrics: 获取指标列表(可选过滤)
  • get_metric: 通过 ID 获取特定指标
  • get_metric_aggregate: 获取指标的聚合数据
  • get_metric_timeline: 获取指标的时间线数据

Catalogs

  • get_catalogs: 获取目录列表
  • get_catalog: 通过 ID 获取特定目录
  • get_catalog_items: 获取目录中的项目
  • get_catalog_item: 获取目录中的特定项目
  • create_catalog_item: 在目录中创建新项目
  • update_catalog_item: 更新目录中的现有项目
  • delete_catalog_item: 从目录中删除项目

Data Privacy

  • create_deletion_request: 创建新的数据删除请求
  • get_deletion_requests: 获取数据删除请求列表
  • get_deletion_request: 通过 ID 获取特定数据删除请求

常见问题解答

  • 如何设置 API 密钥?在 .env 文件中设置 KLAVIYO_API_KEY 环境变量。
  • 如何测试服务器?使用 npm run inspect 命令启动 MCP Inspector 进行测试。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 克隆仓库: git clone <repository_url>

安装教程

  1. 安装依赖: npm install
  2. 创建 .env 文件并添加 Klaviyo API 密钥: KLAVIYO_API_KEY=your_private_api_key_here
  3. 启动服务器: npm run dev

调试方式

  1. 使用 MCP Inspector 进行测试: npm run inspect
  2. 在打开的 web 界面中浏览可用工具和资源,测试工具输入,查看服务器日志和响应。

许可证

该项目遵循 None 开源许可条款。