article
README
🚀 Klaviyo MCP 服务器
Klaviyo MCP 服务器全面覆盖 Klaviyo API 端点,提供丰富的 MCP 工具与资源,便于操作 Klaviyo 数据。同时,它还能轻松与大型语言模型集成,借助 Model Context Protocol 发挥更大价值。
🚀 快速开始
安装
- 克隆此仓库。
- 安装依赖:
npm install - 根据
.env.example创建一个.env文件,并添加你的 Klaviyo API 密钥:KLAVIYO_API_KEY=your_private_api_key_here - 启动服务器:
npm run dev
使用 MCP 检查器测试
你可以使用 MCP 检查器进行测试:
npm run inspect
这将打开一个网络界面,你可以在其中测试所有可用的工具和资源。
✨ 主要特性
- 完整覆盖 Klaviyo API 端点。
- 提供所有主要 Klaviyo 操作的 MCP 工具。
- 提供访问 Klaviyo 数据的 MCP 资源。
- 方便与大型语言模型 (LLM) 集成,通过 Model Context Protocol(模型上下文协议)。
💻 使用示例
基础用法
以下是使用 MCP 检查器测试的示例:
npm run inspect
这将打开一个网络界面,你可以在其中测试所有可用的工具和资源。
📚 详细文档
可用工具
用户配置文件
get_profiles:从 Klaviyo 获取用户配置文件。get_profile:获取特定用户配置文件。create_profile:在 Klaviyo 创建新的用户配置文件。update_profile:更新现有的用户配置文件。delete_profile:删除用户配置文件。
列表
get_lists:从 Klaviyo 获取列表。get_list:获取特定列表。create_list:在 Klaviyo 创建新的列表。add_profiles_to_list:将用户配置文件添加到列表中。
分段
get_segments:从 Klaviyo 获取分段。get_segment:获取特定分段。
事件
get_events:从 Klaviyo 获取事件。create_event:在 Klaviyo 创建新的事件。
指标
get_metrics:从 Klaviyo 获取指标。get_metric:获取特定指标。
营销活动
get_campaigns:从 Klaviyo 获取营销活动。get_campaign:获取特定营销活动。
流程
get_flows:从 Klaviyo 获取流程。get_flow:获取特定流程。update_flow_status:更新流程的状态。
模板
get_templates:从 Klaviyo 获取模板。get_template:获取特定模板。create_template:在 Klaviyo 创建新的模板。
目录
get_catalogs:从 Klaviyo 获取目录。get_catalog_items:从目录中获取项目。get_catalog_item:获取特定项目的目录信息。
标签
get_tags:从 Klaviyo 获取标签。create_tag:在 Klaviyo 创建新的标签。update_tag:更新现有标签。delete_tag:删除标签。
资源
用户配置文件
get_profile:获取特定用户配置文件。create_profile:创建新用户配置文件。update_profile:更新现有用户配置文件。delete_profile:删除用户配置文件。
列表
get_lists:从 Klaviyo 获取列表。get_list:获取特定列表。create_list:在 Klaviyo 创建新的列表。add_profiles_to_list:将用户配置文件添加到列表中。
营销活动
get_campaigns:从 Klaviyo 获取营销活动。get_campaign:获取特定营销活动。update_campaign_status:更新营销活动的状态。
📄 API 文档
有关 Klaviyo API 的更多信息,请参阅 官方文档。
微信扫一扫