Sequenzy MCP Server
Official MCP server for Sequenzy, the AI-powered email marketing platform.
Connect Sequenzy to Claude Desktop, Claude Code, Codex, Cursor, Windsurf, VS Code Copilot, OpenClaw, and other MCP clients so your AI assistant can manage email operations with structured tools instead of hand-written API calls.
What You Can Do
- Manage subscribers, tags, lists, and dynamic segments, including bulk tag reconciliation and synthetic event testing.
- Sync segments to Meta custom audiences for Facebook and Instagram retargeting.
- Manage products and attach digital delivery files for purchase automations.
- Upload hosted email images with alt text and reusable responsive crop settings.
- Draft, update, schedule, and inspect campaigns, including resolved audience previews, persisted conversion goals, and From, Reply-To, CC, and BCC identities.
- Render campaigns, sequence steps, and templates to their exact email-safe HTML without sending.
- Add one-click Poll and NPS survey blocks to emails and inspect campaign response summaries.
- Create and edit email sequences, including multi-list/tag triggers, entry-audience and property-filtered stop conditions, sending identity overrides, existing graph restructuring, and direct step test sends to internal reviewers.
- Cancel, pause, resume, duplicate, or delete campaigns and enroll contacts into sequences.
- Manage transactional email templates and send transactional emails to shared To, Cc, and Bcc recipient lists.
- Create, preview, edit, publish, unpublish, and delete landing pages.
- Create list-scoped saved signup forms with responsive stack, row, grid, and
single-image overlay block groups (including foreground gap controls), then
return client-safe static-site embeds. - Create, target, publish, duplicate, and deploy saved signup popups with the
same recursive block layouts. - Connect and verify custom domains for published landing pages.
- Manage team invitations, inbox conversations, and outbound webhook endpoints.
- Generate email copy, subject lines, and multi-step sequences.
- Inspect analytics, subscriber activity, deliverability health, company-level sending pauses, integrations, published event payload schemas, sending identities, tracking settings, and dashboard URLs.
- Inspect whether "Sent with Sequenzy" is visible for a workspace, why the owner subscription does or does not remove it, and open the canonical subscription page for an upgrade or renewal. Entitlement changes apply to future sends from existing live sequences without editing their blocks.
- Diagnose why sending is paused and restore eligible hard-bounce pauses after confirming list cleanup.
- Inspect exact-recipient bounce, complaint, and email-hygiene suppression, and clean up eligible stale bounces without exposing the shared SES suppression list.
- Configure company product info, account-wide sending identity defaults, rename individual sender and reply-to profiles, manage sender domains, and inspect integration examples for common frameworks.
Every published MCP tool includes explicit readOnlyHint, destructiveHint, and openWorldHint annotations so compatible clients can display accurate tool-use affordances. Tools also publish outputSchema definitions and return structuredContent, giving clients and models machine-readable result shapes for follow-up calls.
Quick Setup
The easiest setup path is the Sequenzy wizard:```bash
npx @sequenzy/setup
The wizard opens the browser login flow, creates a personal API key, detects supported AI clients, and configures them automatically when possible.
## Hosted Remote MCP
For clients that support Streamable HTTP MCP, use Sequenzy's hosted endpoint instead of running a local stdio process:```text
https://api.sequenzy.com/v1/mcp
ChatGPT and the OpenAI plugin directory use the reviewed hosted surface:```text
https://api.sequenzy.com/v1/mcp/openai
That surface shares the same implementation and keeps the standard tool set
except for six operations: `connect_integration`, `create_api_key`,
`create_webhook`, `list_webhook_deliveries`, `replay_webhook_delivery`, and
`rotate_sequence_inbound_webhook_secret`. Feedback stays available with a
reduced schema for generalized, explicitly requested product feedback.
Remote clients should authenticate with the Sequenzy OAuth flow when supported. Local and automation clients can still use the stdio package below with `SEQUENZY_API_KEY`.
The hosted endpoint and the stdio package support MCP specification
`2026-07-28` while remaining compatible with 2025-era clients. Modern HTTP
clients use per-request discovery and method headers; existing clients keep
working through the same endpoint and package command.
Machine-readable discovery files:
- MCP server manifest: `server.json`
- Agent card: `.well-known/agent-card.json`
- Agent capability manifest: `agent-capability.json`
- OpenClaw skill metadata: `openclaw/skill.json`
### Data and privacy
Sequenzy sends an MCP client only the data needed for the tool the user asks it
to run, within the selected workspace and the key or OAuth scopes granted to
that client. Depending on the requested tool, this can include workspace names
and IDs; subscriber contact, consent, audience, attribute, event, engagement,
reply, survey, and commerce data; campaign and automation content; delivery
analytics; and integration or webhook status. See the
Sequenzy Privacy Policy for the full categories,
purposes, recipients, retention periods, and user controls.
Do not use open-ended custom attributes, events, notes, forms, webhook samples,
email variables, or feedback to submit payment-card data, health or medical
data, government identifiers, biometric or genetic data, authentication
credentials, sensitive demographic data, or precise geolocation.
The OpenAI-reviewed route states and enforces those restrictions on relevant
open-ended inputs, including nested attribute paths such as `profile.ssn`,
coordinate pairs such as `lat`/`lng`, and labelled prose such as
`Religion: ...` or `GPS coordinates: ...`. It rejects a credential-bearing URL
in any argument, whether the credential sits in the userinfo, path, query, or
fragment, such as a form or popup `redirectUrl` with an access token or URL
signature. Restricted attribute selectors inside merge tags are rejected
without blocking ordinary authored copy about the same topic. On this surface,
`render_email` accepts sample data or a policy-checked inline `subscriber`, but
not `subscriberId`, so it cannot resolve uninspected stored custom attributes.
Its results remove restricted fields, raw API errors, debug payloads, internal
request/trace/session identifiers, unnecessary account or credential
identifiers, stored credential-bearing URLs, and inbound-webhook URLs. Standard
remote MCP and the local stdio package retain the complete contract for trusted
clients, including credential-based integration setup, one-time API-key and
webhook secrets, inbound-webhook URLs, and detailed API errors. Prefer the
dashboard or local CLI when secrets should stay outside an AI conversation.
`submit_feedback` runs only when the user explicitly asks; its OpenAI schema is
limited to a generalized message, category, and optional workflow context, and
the route rejects feedback text that contains an email address or resource ID.
What the reviewed surface guarantees is bounded. It recognizes restricted data
by shape: English field-name words such as `passport_id`, `user.ssn`, or
`api_secret` at any nesting depth, labelled prose such as `Diagnosis: ...`,
known credential shapes, decimal coordinate pairs, and credential-bearing URLs
inside any string, including HTML. It does not interpret unlabelled prose,
non-English field names, or values a client deliberately obfuscates; those
remain covered by the usage restriction above rather than by the filter.
## Manual Setup
All stdio MCP clients use the same command:
- Command: `npx`
- Args: `-y @sequenzy/mcp`
- Required env: `SEQUENZY_API_KEY=seq_user_your_key_here`
Optional environment variables:
- `SEQUENZY_API_URL` - Sequenzy API base URL. Defaults to `https://api.sequenzy.com`.
- `SEQUENZY_APP_URL` - Sequenzy dashboard base URL used by app URL helpers. Defaults to `https://sequenzy.com`.
### Claude Desktop
Add this to your Claude Desktop config:
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
- Windows: `%APPDATA%\Claude\claude_desktop_config.json````json
{
"mcpServers": {
"sequenzy": {
"command": "npx",
"args": ["-y", "@sequenzy/mcp"],
"env": {
"SEQUENZY_API_KEY": "seq_user_your_key_here"
}
}
}
}
Restart Claude Desktop after editing the config.
Claude Code```bash
claude mcp add --scope user --env=SEQUENZY_API_KEY=seq_user_your_key_here sequenzy -- npx -y @sequenzy/mcp
On native Windows, wrap `npx` with `cmd /c`:```bash
claude mcp add --scope user --env=SEQUENZY_API_KEY=seq_user_your_key_here sequenzy -- cmd /c npx -y @sequenzy/mcp
For a shared project config, use .mcp.json:```json
{
"mcpServers": {
"sequenzy": {
"command": "npx",
"args": ["-y", "@sequenzy/mcp"],
"env": {
"SEQUENZY_API_KEY": "seq_user_your_key_here"
}
}
}
}
### Codex```bash
codex mcp add sequenzy --env SEQUENZY_API_KEY=seq_user_your_key_here -- npx -y @sequenzy/mcp
codex mcp list
Manual Codex config in ~/.codex/config.toml:```toml
[mcp_servers.sequenzy]
command = "npx"
args = ["-y", "@sequenzy/mcp"]
[mcp_servers.sequenzy.env]
SEQUENZY_API_KEY = "seq_user_your_key_here"
### Cursor
Install **Sequenzy** from the Cursor Marketplace for a hosted connection with Sequenzy OAuth. The plugin connects to:```text
https://api.sequenzy.com/v1/mcp
After installing, complete the browser sign-in flow. Cursor's agent can then use Sequenzy tools from chat, including when Grok is the selected model.
For a manual local stdio setup instead, add this to ~/.cursor/mcp.json:```json
{
"mcpServers": {
"sequenzy": {
"command": "npx",
"args": ["-y", "@sequenzy/mcp"],
"env": {
"SEQUENZY_API_KEY": "seq_user_your_key_here"
}
}
}
}
### Windsurf
Use the same JSON shape as Cursor.
- macOS: `~/Library/Application Support/Windsurf/mcp.json`
- Windows: `%APPDATA%\Windsurf\mcp.json`
### VS Code Copilot
VS Code uses a `servers` object:```json
{
"servers": {
"sequenzy": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@sequenzy/mcp"],
"env": {
"SEQUENZY_API_KEY": "seq_user_your_key_here"
}
}
}
}
Other MCP Clients
For OpenClaw, Hermes, and other MCP-compatible clients, point the client at npx -y @sequenzy/mcp and set SEQUENZY_API_KEY.
Getting an API Key
- Open the Sequenzy dashboard.
- Use the MCP setup flow to create a personal key, or open Settings ->
API Keys to create a company key. - Choose a permission preset or the exact custom scopes the integration needs.
- Add the key to your MCP client config.
Personal keys start with seq_user_. You can revoke them any time in the dashboard.
Company keys can also be cleaned up without exposing secrets. Call
list_api_keys to compare the key ID, name, non-secret prefix, permissions,
last-use timestamp, and isCurrent marker, then pass the exact ID to
revoke_api_key. delete_api_key is a compatibility alias for the same
permanent operation. List and revoke responses never contain the plain key or
stored key hash.
Recover from missing API key permissions
If a tool reports a missing scope such as campaigns:read or
templates:write, call get_account. Its apiKeyPermissions field lists the
current key identity and type, scopes, common missing marketing read scopes, and
a direct manageUrl. The OpenAI-reviewed route returns the same permissions
without the user's account ID or the active key's identity. Personal keys open
Account API Keys; company keys open the selected workspace's API Keys settings.
If the key does not include
account:read, open the
Sequenzy dashboard directly and choose the
matching API Keys page.
Permissions are editable in place, so open manageUrl. For a company key, use
list_api_keys and its isCurrent flag to identify the active key before
editing it, then retry the failed tool without replacing the credential or
restarting the client. An agent using a company key with api_keys:manage can
instead call update_api_key; personal keys must be edited on the account-level
page because that tool only manages company keys. Its scopes and preset
inputs replace the whole permission selection rather than merging, so preserve
every existing scope that is still needed. Hosted OAuth connections can
alternatively disconnect and reauthorize with broader permissions.
When the active key itself lacks api_keys:manage, call
request_api_key_handoff instead of retrying update_api_key. It requires
account:read and returns an owner-review URL with the requested key name,
permissions, and optional predecessor prefilled. It never creates or returns a
key; the workspace owner reviews the form, creates the replacement in the
browser, and copies it into the client. Pass replaceApiKeyId: "current" to
offer revocation of the active key after the replacement is created. If the
active key also lacks account:read, use the dashboard directly.
The default Safer agent access preset includes lists:write and
tags:write, so agents can create and update list and tag definitions, and it
includes subscribers:tag for applying tags to existing contacts. It also
includes ab_tests:read, ab_tests:write, and sequences:write, so agents can
audit and edit sequence A/B variant copy, including cart and browse abandonment
messages. It does not include subscribers:write, so it cannot add contacts to
lists or remove them from lists. Deleting a list or tag still requires the
matching lists:delete or tags:delete permission.
The AI drafting preset includes subscribers:write, so drafting agents can
build a list as well as create it. Imports that apply listIds also need
lists:write; sequence enrollment or double-opt-in delivery additionally needs
automations:trigger.
Tools
The standard surface currently exposes 243 MCP tools. The OpenAI-reviewed
surface exposes 237; only the six operations listed above are omitted.
Tools reject arguments they do not declare instead of silently ignoring them.
Errors name the unsupported fields, list the supported arguments, and provide
focused guidance for common mistakes such as invented subscriber filters or
sort options.
Account, Companies, Setup
| Tool | Description |
|---|---|
get_account |
Get account info, available companies, current key permissions, and the API Keys management URL. |
select_company |
Set the active company for future tool calls. |
get_app_urls |
Build dashboard URLs for campaigns, landing pages, sequences, emails, settings, subscription management, domains, and sent email details. settingsTab: "billing" resolves to Account -> Subscription. |
create_company |
Create a new company or brand. |
get_company |
Read company details, product info, brand context, localization, reply-tracking settings, current From/Reply-To defaults, and the effective read-only emailBranding entitlement with plan/status reason and subscription URL; STO is explicitly identified as campaign-only. |
update_company |
Edit product info, brand context, email theme, reply tracking, and account-wide From/Reply-To profile defaults or names. |
get_sync_rules |
Read the company's event-to-tag rules and whether it uses the inherited platform preset. |
update_sync_rules |
Replace all sync rules; pass [] to disable them or null to opt into the SaaS/ecommerce platform preset. |
get_shopify_automation_settings |
Read browse-abandonment, cart-abandonment, and price-drop settings for the connected Shopify store. |
update_shopify_automation_settings |
Partially update Shopify automation settings or reset an individual section to its platform defaults. |
create_api_key |
Create a company API key and return its one-time secret on standard MCP; omitted from the OpenAI-reviewed route. |
request_api_key_handoff |
Prepare an owner-reviewed create/rotation URL when the active key cannot manage API keys itself. |
list_api_keys |
List company API keys as non-secret metadata for safe identification and cleanup. |
update_api_key |
Rename a company API key or replace its permission preset or scopes without changing the key value. |
revoke_api_key |
Permanently revoke an exact company API key by ID after checking it with list_api_keys. |
delete_api_key |
Compatibility alias for revoke_api_key. |
list_websites |
List sending domains with stored aggregate, SPF, DKIM, and MAIL FROM status. |
add_sending_domain |
Add a sending domain and return its cohort-specific DNS setup records. |
add_website |
Compatibility alias for add_sending_domain. |
check_website |
Read a sending domain's stored SPF, DKIM, MAIL FROM, and aggregate verification details. |
verify_sending_domain |
Run a fresh sending-domain DNS/provider verification and return current status and diagnostics. |
list_integrations |
List connected integrations with connection and sync health, without returning credentials. |
get_sending_status |
Diagnose active, paused, or suspended sending, including enforcement denominators, review gates, and remediation steps. |
resume_sending |
Restore an eligible hard-bounce pause after explicitly confirming the list has been sanitized. |
get_tracking_settings |
Read account-wide and Transactional API open/click defaults, unsubscribe, attribution, UTM, click-domain, reply-tracking, and double-opt-in settings. |
update_tracking_settings |
Update account-wide and Transactional API tracking defaults, attribution, UTM, and account-wide double opt-in. |
get_integration_guide |
Get framework-specific integration examples. |
get_integration |
Inspect one connected integration, its event wiring, list targeting, recent activity, and recommendations. |
list_integration_capabilities |
Compare provider capabilities whether or not they are connected. |
connect_integration |
Connect supported API-key or webhook-secret providers on standard MCP, including managed Lemon Squeezy webhooks, outbound-only Attio, and optional PostHog/Segment history import; omitted from the OpenAI-reviewed route. |
get_event_schema |
Inspect published event payload examples, property paths, types, and merge tags by provider. |
list_integration_activity |
Read the retained integration-specific webhook and sync activity log. |
set_integration_sync_enabled |
Enable or disable bulk imports and backfills while leaving live webhooks connected. |
set_integration_list_targeting |
Choose which lists contacts created by a supported integration join on future provider writes. |
sync_integration |
Queue payment revenue, Supabase users, or a PostHog/Segment event-history import using the saved integration configuration. |
get_integration_pixel |
Read Shopify's live pixel/configuration state and distinguish confirmed dark events from an unknown read. |
activate_integration_pixel |
Install or repoint Shopify's storefront pixel; idempotent when it is already current. |
list_web_tracking_keys |
List publishable website-tracking keys, origin restrictions, usage state, and install snippets. |
get_web_tracking_key |
Get one website-tracking key with its exact install snippet and ingest endpoint. |
create_web_tracking_key |
Create a publishable tracking key for a non-Shopify storefront or website. |
update_web_tracking_key |
Rename, restrict, revoke, or re-enable a website-tracking key. |
delete_web_tracking_key |
Permanently delete a website-tracking key after its snippet has been removed. |
list_sender_profiles |
List sender and reply-to profiles, defaults, and sending-domain readiness. |
update_sender_profile |
Rename one sender or reply-to profile without changing the account defaults. |
delete_sender_profile |
Permanently delete an unused sender profile, with guards for live sending surfaces and the last remaining sender. |
get_notification_preferences |
Read the current user's per-company account notification settings and supported modes, including the Monday weekly report. |
…(正文过长,页面只展示前面部分,完整内容见仓库)