article
README
🚀 Klaviyo API MCP 服务器
Klaviyo API MCP 服务器是一个全面的模型上下文协议(MCP)服务器,用于与 Klaviyo 的 API 进行交互。它提供了丰富的工具和资源,可用于管理配置文件、列表、事件、活动、流程、模板、段、指标、目录和数据隐私等。
🚀 快速开始
Klaviyo API MCP 服务器能帮助你便捷地与 Klaviyo 的 API 进行交互,以下是快速开启使用的步骤。
✨ 主要特性
- 全面覆盖 Klaviyo 的 API 功能,为你提供一站式服务。
- 使用 Zod 进行适当验证的结构化工具,确保数据输入的准确性。
- 提供 API 参考文档资源,方便你深入了解和使用。
- 具备错误处理和日志记录功能,让你及时发现和解决问题。
📦 安装指南
- 克隆此仓库。
- 安装依赖项:
npm install - 创建一个
.env文件,包含你的 Klaviyo API 密钥:KLAVIYO_API_KEY=your_private_api_key_here - 启动服务器:
npm run dev
💻 使用示例
基础用法
你可以使用 MCP 监视器进行测试:
npm run inspect
这将打开一个网络界面,允许你:
- 查看可用工具和资源。
- 使用不同输入测试工具。
- 查看服务器日志和响应。
高级用法
以下为你详细介绍服务器提供的各类可用工具。
配置文件
get_profiles:获取配置文件列表,可选过滤。get_profile:获取特定配置文件 ID。create_profile:创建新配置文件。update_profile:更新现有配置文件。delete_profile:删除配置文件。
列表
get_lists:获取所有列表。get_list:通过 ID 获取特定列表。create_list:创建新列表。update_list:更新现有列表。delete_list:删除列表。get_list_profiles:获取列表中的配置文件。add_profiles_to_list:将配置文件添加到列表。remove_profiles_from_list:从列表中移除配置文件。
事件
get_events:获取事件列表,可选过滤。get_event:通过 ID 获取特定事件。create_event:创建新事件。
活动
get_campaigns:获取活动列表,可选过滤。get_campaign:通过 ID 获取特定活动。create_campaign:创建新活动。update_campaign:更新现有活动。delete_campaign:删除活动。
流程
get_flows:获取所有流程。get_flow:通过 ID 获取特定流程。create_flow:创建新流程。update_flow:更新现有流程。delete_flow:删除流程。
模板
get_templates:获取所有模板。get_template:通过 ID 获取特定模板。create_template:创建新模板。update_template:更新现有模板。delete_template:删除模板。
段
get_segments:获取所有段。get_segment:通过 ID 获取特定段。create_segment:创建新段。update_segment:更新现有段。delete_segment:删除段。
指标
get_metrics:获取指标列表。get_metric:通过 ID 获取特定指标。create_metric:创建新指标。update_metric:更新现有指标。delete_metric:删除指标。
目录
get_directories:获取所有目录。get_directory:通过 ID 获取特定目录。create_directory:创建新目录。update_directory:更新现有目录。delete_directory:删除目录。
📚 详细文档
- 文档路径:提供详细的 API 参考和使用说明。
微信扫一扫