93 lines
2.5 KiB
Markdown
93 lines
2.5 KiB
Markdown
# Klaviyo MCP Server
|
|
|
|
Complete Klaviyo Model Context Protocol server with 60+ tools and 16 production-ready apps.
|
|
|
|
## Features
|
|
|
|
### Tools (60+)
|
|
- **Profiles**: Create, update, subscribe, unsubscribe, suppress
|
|
- **Lists**: Create, update, delete, manage profiles
|
|
- **Segments**: View, update, get profiles and tags
|
|
- **Campaigns**: Create, update, send, clone, manage messages
|
|
- **Flows**: Create, update, manage actions and messages
|
|
- **Templates**: Create, update, clone, delete
|
|
- **Metrics**: Query aggregate data
|
|
- **Events**: Track events, get related data
|
|
- **Catalogs**: Manage items and variants
|
|
- **Forms**: View forms
|
|
- **Tags**: Create, update, delete, tag campaigns/flows
|
|
- **Reporting**: Campaign and flow analytics
|
|
|
|
### Apps (16)
|
|
1. **Profile Manager** - Manage customer profiles and subscriptions
|
|
2. **List Builder** - Create and manage email lists
|
|
3. **Segment Viewer** - View and analyze customer segments
|
|
4. **Campaign Dashboard** - Monitor and manage campaigns
|
|
5. **Flow Designer** - Create and manage automated flows
|
|
6. **Template Gallery** - Browse and manage email templates
|
|
7. **Metrics Dashboard** - Track key performance metrics
|
|
8. **Event Feed** - Real-time customer event tracking
|
|
9. **Catalog Browser** - Browse and manage product catalog
|
|
10. **Form Manager** - Manage signup forms and popups
|
|
11. **Tag Organizer** - Organize campaigns and flows with tags
|
|
12. **Email Analytics** - Track email performance metrics
|
|
13. **Revenue Dashboard** - Track revenue and sales performance
|
|
14. **A/B Test Viewer** - Analyze campaign A/B test results
|
|
15. **Audience Builder** - Build targeted audiences
|
|
16. **Integration Status** - Monitor integration health and data sync
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Set your Klaviyo API key:
|
|
|
|
```bash
|
|
export KLAVIYO_API_KEY=your_api_key_here
|
|
```
|
|
|
|
## Usage
|
|
|
|
### As MCP Server
|
|
|
|
```bash
|
|
npm run build
|
|
node dist/index.js
|
|
```
|
|
|
|
### Development
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
### Type Check
|
|
|
|
```bash
|
|
npm run typecheck
|
|
```
|
|
|
|
## API
|
|
|
|
All tools follow Klaviyo's JSON:API format with:
|
|
- Bearer token authentication
|
|
- API revision: 2024-02-15
|
|
- Rate limit: 75 requests/second (automatic throttling)
|
|
- Cursor-based pagination
|
|
|
|
## Architecture
|
|
|
|
- **Client**: Axios-based client with rate limiting and error handling
|
|
- **Types**: Full TypeScript definitions for all Klaviyo resources
|
|
- **Tools**: 12 tool modules covering all major Klaviyo APIs
|
|
- **Apps**: 16 React apps with ErrorBoundary, Suspense, dark theme, responsive design
|
|
- **UI Components**: Shared components (Toast, LoadingSkeleton, hooks)
|
|
|
|
## License
|
|
|
|
MIT
|