Ongage MCP Server (Beta)

Ongage MCP Server (Beta)

MCP

Ongage MCP Server

Configure Ongage's MCP server to get AI assistance with your email marketing data.


What You'll Learn

The Ongage Model Context Protocol (MCP) server seamlessly integrates with Ongage's APIs, enabling AI clients to interact with your email marketing data. This guide will walk you through configuring various MCP clients to connect to the Ongage MCP server.

MCP Endpoint: <https://api.ongage.com/mcp>

What is MCP?

MCP (Model Context Protocol) is an open protocol that helps AI models securely interface with different data sources and tools. You'll connect Ongage's MCP server to an MCP client (an AI agent like Claude, Cursor, or VS Code) to get assistance with your email marketing operations.

Your MCP client can help with a variety of tasks, including:

  • Campaign Management – Schedule and manage email campaigns

  • Email Creation – Create and manage email templates

  • Analytics – Query campaign performance metrics using natural language

  • Automation – View and analyze workflow performance

  • Segmentation – Access and understand your audience segments


Configure Your MCP Client

To communicate with the Ongage MCP server, each MCP client needs specific configuration. Choose the setup method that fits your use case.

Option A — Claude Connector (Recommended)

The fastest way to get started. No API key or Node.js installation required. Works with both http://Claude.ai (web) and Claude Desktop on Pro, Team, and Enterprise plans.

💡 This is the recommended method for most users. You'll be up and running in under a minute.

Step 1: Admin Adds the Connector

An organization admin or user with access goes to Settings → Connectors and adds Ongage from the available integrations.

As noted above the MCP Endpoint is: <https://api.ongage.com/mcp>

image-20260224-122228.png

Step 2: Users Click "Connect"

Once the admin (or user) has added Ongage, everyone in the organization can go to Settings → Connectors and click "Connect" next to Ongage.

image-20260224-122252.png

Step 3: Authorize Access

You'll be redirected to Ongage to authorize access. Click Allow.

image-20260224-122259.png

That's it! Go back to Claude and try asking: "Get my Ongage account info"

Verify: You should see the Ongage tools available in Claude's tool list. Try "Show my campaign analytics for the last 7 days" to confirm everything is working.


Option B — Manual Setup with API Key

Use this method for Cursor, VS Code, or if you prefer to connect with your own API key (e.g., personal accounts without an organization).

Prerequisites

  • An active Ongage account

  • An Ongage API key (obtain from your Ongage account settings)

  • A compatible MCP client (Claude Desktop, Cursor, VS Code, etc.)

  • Node.js (v18 or later) installed on your machine

⚠️ Node.js is required for the manual method. The npx command (bundled with Node.js) runs a lightweight bridge to the MCP server.

Installing Node.js

macOS

Option A — Official installer: Go to https://nodejs.org and download the macOS installer (LTS recommended). Run the .pkg file and follow the prompts.

Option B — Homebrew:

brew install node

Windows

Option A — Official installer: Go to https://nodejs.org and download the Windows installer (LTS recommended). Run the .msi file and follow the prompts. Make sure the "Add to PATH" option is checked during installation. Restart any open terminals after installing.

Option B — winget:

winget install OpenJS.NodeJS.LTS

Verify Installation

Open a terminal (or Command Prompt on Windows) and run:

node -v npm -v

Both commands should return version numbers. If not, restart your terminal and try again.


Claude Desktop

  1. Download Claude Desktop.

  2. Open Claude Desktop. Navigate to Settings > Developer > Edit Config and add the following configuration:

{ "mcpServers": { "ongage": { "command": "npx", "args": [ "-y", "mcp-remote", "https://api.ongage.com/mcp", "--header", "X-Api-Key:${API_KEY}" ], "env": { "API_KEY": "YOUR_ONGAGE_API_KEY" } } } }
  1. Replace YOUR_ONGAGE_API_KEY with your actual Ongage API key.

  2. Save the configuration, terminate all Claude processes, and relaunch Claude to apply the new settings.

  3. Verify the connection by asking a test question like "Get my Ongage account info."

Cursor

  1. Download Cursor.

  2. Open Cursor. Navigate to Settings > Cursor Settings > MCP > New MCP Server and add the following:

{ "mcpServers": { "ongage": { "command": "npx", "args": [ "-y", "mcp-remote", "https://api.ongage.com/mcp", "--header", "X-Api-Key:${API_KEY}" ], "env": { "API_KEY": "YOUR_ONGAGE_API_KEY" } } } }
  1. Replace YOUR_ONGAGE_API_KEY with your actual Ongage API key.

  2. Save your changes, restart Cursor, and verify the connection.

VS Code

  1. Download VS Code.

  2. Open VS Code. Open MCP User Configuration (Ctrl + Shift + P > MCP: Open User Configuration) and add the following:

{ "servers": { "ongage": { "command": "npx", "args": [ "-y", "mcp-remote", "https://api.ongage.com/mcp", "--header", "X-Api-Key:${API_KEY}" ], "env": { "API_KEY": "YOUR_ONGAGE_API_KEY" } } } }
  1. Replace YOUR_ONGAGE_API_KEY with your actual Ongage API key.

  2. Save your changes. From the command palette (Ctrl+Shift+P on Windows or Cmd+Shift+P on Mac), search for MCP: List Servers, then select ongage > Start Server.


Available Tools

The Ongage MCP server provides the following tools organized by category.

Analytics

Tool

Description

Tool

Description

ask_analytics

Query campaign performance metrics (opens, clicks, bounces, CTR, complaints, and more) using natural language. Covers all campaigns including automations. Defaults to last 7 days if no timeframe is given.

get_workflow_analytics

Get detailed analytics for automation workflows within a specified date range. Defaults to last 2 weeks if dates are not provided.

Email Creation

Tool

Description

Tool

Description

create_email

Create a new email message (template) with full HTML content, subject line, and name for a specific list.

edit_email

Update an existing email's name, subject line, and/or HTML content.

get_email

Retrieve a specific email by ID, including its full HTML content for preview.

list_emails

List all email messages and templates for a given mailing list with pagination and sorting.

Campaign Management

Tool

Description

Tool

Description

schedule_campaign

Schedule a new email campaign by specifying the email, target segment, ESP connection, send time, and optional excluded segments.

list_campaigns

List all campaigns in the account.

Segmentation

Tool

Description

Tool

Description

list_segments

List all segments for a mailing list, including their JSON criteria and rules configuration.

get_segment

Get detailed information for a specific segment, including its full filter criteria and rules.

Automation

Tool

Description

Tool

Description

list_workflows

List all automation workflows with their IDs, names, and configurations.

get_workflow

Get detailed workflow configuration including triggers, actions, and conditions.

Account & Setup

Tool

Description

Tool

Description

get_account_info

Get account details including default list ID, total contacts count, users count, and lists count.

list_lists

List all mailing lists in the account (use this to get list IDs required by other tools).

list_connections

List all ESP connections (vendors) with their IDs, titles, and ESP names.


Example Prompts

Here are some examples showing how you can combine multiple capabilities in a single prompt.

Analytics & Insights

  • "Show me opens, clicks, and bounce rates for all campaigns sent in the last 30 days, and highlight any campaign with a CTR below 1%."

  • "Compare my automation workflow performance against my regular campaigns for the past month — which channel drives more engagement?"

  • "What are my top 3 segments by open rate this quarter?"

Create & Schedule Campaigns

  • "Create a new email with the subject 'Summer Flash Sale — 48 Hours Only!', use a clean promotional layout with a hero image placeholder and a CTA button, then schedule it to my 'Active Subscribers' segment for next Monday at 9 AM EST using my default ESP connection."

  • "Duplicate the HTML from my 'Spring Newsletter' email, update the subject to 'Fall Update' and replace any mention of spring with fall, then save it as a new email."

Cross-Capability Workflows

  • "Pull last month's campaign analytics, find the campaign with the highest click-through rate, then show me which segment and email template it used — I want to replicate that setup for a new campaign next week."

  • "List all my automation workflows, show me the analytics for any workflow with 'welcome' in the name over the past 60 days, and summarize how each one is performing."

  • "Show me the criteria for my 'High Value Customers' segment, then check what campaigns were sent to that segment in the last 30 days and how they performed."

Account & Setup

  • "Get my account info and list all my ESP connections and mailing lists."


Troubleshooting

Node.js / npx not found (manual setup only)

  • Make sure Node.js is installed by running node -v in your terminal.

  • On Windows, ensure Node.js was added to your system PATH during installation. You may need to restart your terminal or PC after installing.

  • If you installed Node.js while your MCP client was open, fully quit and relaunch the client.

MCP client can't find Ongage tools

  • Connector setup: Verify you completed the authorization step and that "Ongage" appears in your Connectors list.

  • Manual setup: Verify your API key is correct and has the necessary permissions. Ensure the configuration file is saved correctly.

  • Restart your MCP client application completely.

Getting inaccurate or inconsistent responses

  • Start a new chat to reset the conversation context.

  • Be specific in your queries by providing relevant details (date ranges, list names, etc.).

  • If asking about analytics, specify the time period you're interested in.

Connection errors

  • Verify your internet connection.

  • Ensure your API key hasn't expired or been revoked.

  • Check that <https://api.ongage.com/mcp> is accessible from your network.


Security Best Practices

  • Never share your API key – Treat it like a password.

  • Use environment variables – Avoid hardcoding API keys in configuration files that might be shared or version-controlled.

  • Rotate keys periodically – Generate new API keys regularly and revoke old ones.

  • Review tool actions – Always review what the AI is doing before confirming actions that modify your data.


Support

If you encounter issues or have questions about the Ongage MCP server:

  • Contact Ongage Support through your account dashboard

  • Visit the Ongage Help Center

  • Reach out to your account manager