Skip to content

Add sending identity fields and domain verification #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
polnikale merged 1 commit into from
Jul 13, 2026
+454 −32
Merged

Add sending identity fields and domain verification #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 31 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ Connect Sequenzy to Claude Desktop, Claude Code, Codex, Cursor, Windsurf, VS Cod
- Manage subscribers, tags, lists, and dynamic segments.
- Sync segments to Meta custom audiences for Facebook and Instagram retargeting.
- Manage products and attach digital delivery files for purchase automations.
- Draft, update, schedule, and inspect campaigns.
- Create and edit email sequences, including event-triggered and segment-entry automations.
- Draft, update, schedule, and inspect campaigns, including From and Reply-To identities.
- Create and edit email sequences, including event-triggered and segment-entry automations and sending identity overrides.
- Cancel, pause, resume, duplicate, or delete campaigns and enroll contacts into sequences.
- Manage transactional email templates and send single transactional emails.
- Create, edit, publish, unpublish, and delete landing pages.
- 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, and dashboard URLs.
- Configure company product info, sender websites, and integration examples for common frameworks.
- Configure company product info, account-wide sending identity defaults, sender domains, and 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.

Expand Down Expand Up @@ -207,7 +207,7 @@ include the missing scopes.

## Tools

This server currently exposes 120 MCP tools.
This server currently exposes 132 MCP tools.

### Account, Companies, Setup

Expand All @@ -217,12 +217,13 @@ This server currently exposes 120 MCP tools.
| `select_company` | Set the active company for future tool calls. |
| `get_app_urls` | Build dashboard URLs for campaigns, landing pages, sequences, emails, settings, domains, and sent email details. |
| `create_company` | Create a new company or brand. |
| `get_company` | Read company details, product info, brand colors, AI writing context, and localization settings. |
| `update_company` | Edit product info and brand context AI uses for generated emails. |
| `get_company` | Read company details, product info, brand context, localization, and current From/Reply-To defaults. |
| `update_company` | Edit product info, brand context, and account-wide From/Reply-To defaults. |
| `create_api_key` | Create an API key for a company, with optional permission preset or explicit scopes. |
| `list_websites` | List configured sender websites and domains. |
| `list_websites` | List sending domains with stored aggregate, SPF, DKIM, and MAIL FROM status. |
| `add_website` | Add a sender website. Processing can take around 30 seconds. |
| `check_website` | Check whether a website is processed and ready. |
| `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. |
| `get_integration_guide` | Get framework-specific integration examples. |

### Subscribers
Expand Down Expand Up @@ -372,8 +373,8 @@ Use `get_ab_test` to discover variant IDs before editing. Variant updates accept
| `list_campaigns` | List campaigns, optionally filtered by status. |
| `get_campaign` | Get campaign details and stats. |
| `get_email_send` | Inspect a sent email detail record. |
| `create_campaign` | Create a draft campaign from a prompt, HTML, blocks, a template, or campaign data. |
| `update_campaign` | Update a draft campaign, including campaign data and computed lists. |
| `create_campaign` | Create a campaign with content, data, and optional From/Reply-To identity overrides. |
| `update_campaign` | Update a draft campaign, including content, data, From, and Reply-To. |
| `schedule_campaign` | Schedule a draft or reschedule an existing scheduled campaign. |
| `send_test_email` | Send a test email to one address. |
| `cancel_campaign` | Cancel a scheduled or sending campaign. |
Expand All @@ -388,6 +389,12 @@ remain drafts. Use `templateId`, `blocks`, or `html` only when copying or
preserving existing content rather than asking the agent to author it. Omit all
content fields to create an empty draft for later editing.

Use `update_company` with `fromEmail` and/or `replyTo` to set account-wide
defaults. `fromEmail` must use a configured, verified sending domain; `replyTo`
may be any valid mailbox. `create_campaign`, `update_campaign`,
`create_sequence`, and `update_sequence` accept the same direct-address fields
for resource-specific overrides and create the backing profile when needed.

### Landing Pages

| Tool | Description |
Expand All @@ -406,20 +413,20 @@ Landing page content uses Sequenzy's editor-compatible JSON schema with `version

### Sequences

| Tool | Description |
| -------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `list_sequences` | List email sequences and automation status. |
| `get_sequence` | Get sequence details, including step `nodeId`, linked `emailId`, subject, preview text, and blocks. |
| `create_sequence` | Create AI-generated or explicit-step sequences. |
| `update_sequence` | Update sequence settings, enrollment behavior, existing steps, branch logic, or insert linear steps. |
| `insert_sequence_step` | Insert one new email step, optionally with a delay node before it. |
| `enable_sequence` | Activate a sequence. |
| `disable_sequence` | Freeze a sequence, blocking new enrollments and holding current recipients. |
| `pause_sequence_enrollments` | Stop new enrollments for an active sequence while current recipients continue. |
| `resume_sequence_enrollments` | Reopen new enrollments for an active sequence without changing current recipients. |
| `enroll_subscribers_in_sequence` | Enroll up to 500 subscribers by email, subscriber ID, or both, optionally at a target node. |
| `cancel_sequence_enrollments` | Stop active or waiting enrollments by subscriber or entry-event field values. |
| `delete_sequence` | Delete a sequence. |
| Tool | Description |
| -------------------------------- | --------------------------------------------------------------------------------------------------- |
| `list_sequences` | List email sequences and automation status. |
| `get_sequence` | Get sequence details, including step `nodeId`, linked `emailId`, subject, preview text, and blocks. |
| `create_sequence` | Create AI-generated or explicit-step sequences with optional From/Reply-To overrides. |
| `update_sequence` | Update identity, settings, enrollment, existing steps, branch logic, or insert linear steps. |
| `insert_sequence_step` | Insert one new email step, optionally with a delay node before it. |
| `enable_sequence` | Activate a sequence. |
| `disable_sequence` | Freeze a sequence, blocking new enrollments and holding current recipients. |
| `pause_sequence_enrollments` | Stop new enrollments for an active sequence while current recipients continue. |
| `resume_sequence_enrollments` | Reopen new enrollments for an active sequence without changing current recipients. |
| `enroll_subscribers_in_sequence` | Enroll up to 500 subscribers by email, subscriber ID, or both, optionally at a target node. |
| `cancel_sequence_enrollments` | Stop active or waiting enrollments by subscriber or entry-event field values. |
| `delete_sequence` | Delete a sequence. |

Sequence creation supports:

Expand Down
125 changes: 123 additions & 2 deletions src/tools/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,8 @@ describe("update_company tool validation", () => {
expect(inputSchema?.properties).toHaveProperty("companyContext");
expect(inputSchema?.properties).toHaveProperty("toneVoice");
expect(inputSchema?.properties).toHaveProperty("valueProps");
expect(inputSchema?.properties).toHaveProperty("fromEmail");
expect(inputSchema?.properties).toHaveProperty("replyTo");
});

it("calls the company PATCH API with editable fields", async () => {
Expand Down Expand Up @@ -508,6 +510,61 @@ describe("update_company tool validation", () => {
);
expect(mockApiRequest).not.toHaveBeenCalled();
});

it("forwards account-wide From and Reply-To defaults", async () => {
mockApiRequest.mockResolvedValueOnce({ success: true, company: {} });

const result = await handleToolCall("update_company", {
companyId: "company_123",
fromEmail: "hello@example.com",
fromName: "Acme",
replyTo: "support@example.com",
replyToName: "Acme Support",
});

expect(result.isError).toBeUndefined();
expect(mockApiRequest).toHaveBeenCalledWith(
"PATCH",
"/api/v1/companies/company_123",
{
fromEmail: "hello@example.com",
fromName: "Acme",
replyTo: "support@example.com",
replyToName: "Acme Support",
}
);
});
});

describe("sending domain verification tools", () => {
beforeEach(() => {
mockApiRequest.mockClear();
});

it("publishes and routes fresh sending-domain verification", async () => {
const tool = tools.find(
(candidate) => candidate.name === "verify_sending_domain"
);
expect(tool?.inputSchema.required).toEqual(["domain"]);
mockApiRequest.mockResolvedValueOnce({
success: true,
verified: true,
website: { domain: "mail.example.com", status: "verified" },
});

const result = await handleToolCall("verify_sending_domain", {
companyId: "company_123",
domain: "mail.example.com",
});

expect(result.isError).toBeUndefined();
expect(mockApiRequest).toHaveBeenCalledWith(
"POST",
"/api/v1/websites/mail.example.com/verify",
undefined,
"company_123"
);
});
});

describe("A/B test tools", () => {
Expand Down Expand Up @@ -1114,7 +1171,7 @@ describe("update_campaign tool validation", () => {
expect(payload.appUrls.emailSend).toBe(payload.emailSend.url);
});

it("publishes reply-to update fields in the schema", () => {
it("publishes sending identity update fields in the schema", () => {
const updateCampaignTool = tools.find(
(tool) => tool.name === "update_campaign"
);
Expand All @@ -1131,6 +1188,8 @@ describe("update_campaign tool validation", () => {
expect(inputSchema?.properties).toHaveProperty("blocks");
expect(inputSchema?.properties).toHaveProperty("replyTo");
expect(inputSchema?.properties).toHaveProperty("replyProfileId");
expect(inputSchema?.properties).toHaveProperty("fromEmail");
expect(inputSchema?.properties).toHaveProperty("senderProfileId");
expect(inputSchema?.properties).toHaveProperty("campaignData");
expect(inputSchema?.properties).toHaveProperty("computedLists");
expect(inputSchema?.properties).toHaveProperty("labels");
Expand Down Expand Up @@ -1169,7 +1228,7 @@ describe("update_campaign tool validation", () => {

expect(result.isError).toBe(true);
expect(result.content[0]?.text).toContain(
"Provide at least one of `name`, `subject`, `trackingCode`, `html`, `blocks`, `replyTo`, `replyProfileId`, `campaignData`, `computedLists`, or `labels` when calling `update_campaign`."
"Provide at least one campaign content, sending identity"
);
expect(mockApiRequest).not.toHaveBeenCalled();
});
Expand Down Expand Up @@ -1849,6 +1908,8 @@ describe("create_campaign tool validation", () => {
expect(inputSchema?.properties).toHaveProperty("status");
expect(inputSchema?.properties).toHaveProperty("sentAt");
expect(inputSchema?.properties).toHaveProperty("previewText");
expect(inputSchema?.properties).toHaveProperty("fromEmail");
expect(inputSchema?.properties).toHaveProperty("replyTo");
});

it("requires subject when prompt is not provided", async () => {
Expand Down Expand Up @@ -1930,6 +1991,36 @@ describe("create_campaign tool validation", () => {
);
});

it("forwards campaign sending identity fields", async () => {
mockApiRequest.mockResolvedValueOnce({
success: true,
campaign: { id: "camp_123", name: "Launch", subject: "Hello" },
});

const result = await handleToolCall("create_campaign", {
companyId: "comp_123",
name: "Launch",
subject: "Hello",
fromEmail: "hello@example.com",
fromName: "Acme",
replyTo: "support@example.com",
});

expect(result.isError).toBeUndefined();
expect(mockApiRequest).toHaveBeenCalledWith(
"POST",
"/api/v1/campaigns",
{
name: "Launch",
subject: "Hello",
fromEmail: "hello@example.com",
fromName: "Acme",
replyTo: "support@example.com",
},
"comp_123"
);
});

it("passes tracking code when creating a prompt-based campaign", async () => {
mockApiRequest.mockResolvedValueOnce({
success: true,
Expand Down Expand Up @@ -2016,6 +2107,8 @@ describe("create_sequence tool", () => {
expect(inputSchema?.properties).toHaveProperty("steps");
expect(inputSchema?.properties).toHaveProperty("sendingWindow");
expect(inputSchema?.properties).toHaveProperty("stopCondition");
expect(inputSchema?.properties).toHaveProperty("fromEmail");
expect(inputSchema?.properties).toHaveProperty("replyTo");
const steps = inputSchema?.properties?.["steps"] as
| {
items?: {
Expand Down Expand Up @@ -2187,6 +2280,8 @@ describe("update_sequence tool", () => {
expect(inputSchema?.properties).toHaveProperty("clearSendingWindow");
expect(inputSchema?.properties).toHaveProperty("bccEmails");
expect(inputSchema?.properties).toHaveProperty("clearBccEmails");
expect(inputSchema?.properties).toHaveProperty("fromEmail");
expect(inputSchema?.properties).toHaveProperty("replyTo");
expect(inputSchema?.properties).toHaveProperty("stopCondition");
expect(inputSchema?.properties).toHaveProperty("branch");
expect(inputSchema?.properties).toHaveProperty("insertSteps");
Expand Down Expand Up @@ -2273,6 +2368,32 @@ describe("update_sequence tool", () => {
expect(stopCondition?.properties?.value?.type).toEqual(["string", "null"]);
});

it("forwards sequence From and Reply-To overrides", async () => {
mockApiRequest.mockResolvedValueOnce({ success: true, sequence: {} });

const result = await handleToolCall("update_sequence", {
companyId: "comp_123",
sequenceId: "seq_123",
fromEmail: "hello@example.com",
fromName: "Acme",
replyTo: "support@example.com",
});

expect(result.isError).toBeUndefined();
expect(mockApiRequest).toHaveBeenCalledWith(
"PUT",
"/api/v1/sequences/seq_123",
{
companyId: "comp_123",
sequenceId: "seq_123",
fromEmail: "hello@example.com",
fromName: "Acme",
replyTo: "support@example.com",
},
"comp_123"
);
});

it("passes linear step insertion through to the API", async () => {
mockApiRequest.mockResolvedValueOnce({
success: true,
Expand Down
Loading