optivadim/optimove-mcp-server

Optimove MCP Server

A Model Context Protocol (MCP) server for integrating with the Optimove API. This server provides tools for customer management, campaign automation, model data access, integrations, and transactional messaging.

Features

• Customer Management: Create, update, and retrieve customer data
• Campaign Operations: Manage and trigger marketing campaigns
• Model Data Access: Retrieve model predictions and insights
• Transactional Messaging: Send real-time personalized communications
• Integration Management: Monitor and sync data with external systems

Installation

npm install
npm run build

Configuration

Option 1: Configuration File (Recommended)

1. Copy the example configuration:

   cp config.example.json config.json
   

2. Edit config.json with your Optimove credentials:

   {
     "optimove": {
       "apiKey": "your-actual-api-key-here",
       "baseUrl": "https://api.optimove.com"
     }
   }
   

The server will automatically load configuration on startup if config.json exists.

Option 2: Runtime Configuration

Use the optimove_configure tool to set credentials at runtime:

{
  "apiKey": "your-optimove-api-key",
  "baseUrl": "https://api.optimove.com"
}

This will also save the configuration to config.json for future use.

Option 3: MCP Client Configuration

Configure in Claude Desktop or your MCP client:

{
  "mcpServers": {
    "optimove": {
      "command": "node",
      "args": ["/path/to/mcp/build/index.js"],
      "env": {
        "NODE_ENV": "production"
      }
    }
  }
}

Available Tools

Configuration

• optimove_configure: Set up API credentials and save to config file
• optimove_status: Check current configuration and client status

Customer Management

• optimove_get_customers: Retrieve customer data
• optimove_create_customer: Create new customers
• optimove_update_customer: Update existing customer data

Campaign Management

• optimove_get_campaigns: Retrieve campaign information
• optimove_trigger_campaign: Execute marketing campaigns

Model Data

• optimove_get_model_data: Access model predictions and insights

Transactional Messaging

• optimove_send_transactional: Send real-time messages

Integrations

• optimove_get_integration_status: Check integration health
• optimove_sync_data: Synchronize data with external systems

Usage Example

1. Configure the server:

   {
     "apiKey": "your-optimove-api-key",
     "baseUrl": "https://api.optimove.com"
   }
   

2. Create a customer:

   {
     "customer_id": "12345",
     "email": "customer@example.com",
     "first_name": "John",
     "last_name": "Doe"
   }
   

3. Send a transactional message:

   {
     "customer_id": "12345",
     "template_id": "welcome_email",
     "channel": "email",
     "message_data": {
       "subject": "Welcome!",
       "content": "Welcome to our service!"
     }
   }
   

Development

npm run dev  # Watch mode for development
npm run build  # Build for production

License

MIT