- name
- sequenzy
- description
- Agent guide for operating Sequenzy. Use when Codex needs to authenticate, inspect identity, manage subscribers, create or edit campaigns/sequences/templates, generate draft email content, send a transactional email, read delivery stats, or decide whether a requested Sequenzy workflow is currently supported. Prefer the CLI when it is implemented, and fall back to the dashboard or direct API use when the current CLI surface is only partial.
Sequenzy
Overview
Use this skill when the task is to operate Sequenzy, not to change Sequenzy's source code. Prefer the sequenzy CLI for supported workflows, treat packages/mcp/src/tools/index.ts as the MCP source of truth when the task goes through MCP tools, and explicitly call out when a requested workflow is not wired in the current implementation.
Ground Rules
- Treat
packages/cli/src/index.tsxas the source of truth for which commands are actually wired. - Treat
packages/cli/src/commands/andpackages/cli/src/api.tsas the source of truth for CLI behavior, payload shape, and API routes. - Treat
packages/mcp/src/tools/index.tsas the source of truth for MCP tool names, arguments, and preflight validation. - Do not promise support for commands or tools that only appear in docs or
--helptext without an attached implementation. - Prefer
sequenzy loginfor interactive auth andSEQUENZY_API_KEYfor automation. - Prefer inspection before mutation whenever the workflow allows it.
Supported Workflows
Read references/use-cases.md before executing anything non-trivial. The currently implemented CLI flows are:
- login and logout
- local auth/session check with
whoami - account inspection with
account - company inspection or creation with
companies list|get|create - stats overview or stats by campaign/sequence ID
- subscribers
list,add,get, andremove - lists
listandcreate - tags
list - segments
list,create, andcount, including--match anyin the CLI andfilterJoinOperator: "or"in MCP/API calls - templates
list,get,create,update, anddelete, withcreateandupdateaccepting raw HTML or Sequenzy block JSON - campaigns
list,get,create,updateincluding reply-to updates, andtest, withcreateaccepting raw HTML, Sequenzy block JSON, or prompt-generated content andupdateaccepting raw HTML or Sequenzy block JSON - MCP
update_campaigncalls includingreplyToandreplyProfileId - sequences
list,get,create,update,enable,disable, anddelete - AI generation with
generate email,generate sequence, andgenerate subjects - dashboard URL generation with CLI
urls, MCPget_app_urls, andappUrls/urlfields on campaign, sequence, template, and company results - websites
list,add,check, andguide - API key creation with
api-keys create - send one transactional email by template or raw HTML
Unsupported Or Placeholder Workflows
Treat missing subcommands as unsupported even when the noun exists. For example: campaign send/schedule flows, list deletion, tag mutation, and bulk subscriber import are not available through the current CLI handlers.
Execution Pattern
- Check auth first with
sequenzy whoamior by verifyingSEQUENZY_API_KEYis set. - Pick the narrowest command that matches the use case.
- Validate IDs, recipient email, subject, template, or content input before issuing a mutation.
- Surface CLI limitations directly instead of inventing a workaround.
- If the workflow is unsupported in the CLI, say whether the next-best path is the Sequenzy dashboard or direct API use.
- When you create or inspect a campaign, sequence, template, or company and the user may want to review/edit it, surface the dashboard URL from
urlorappUrlsin the tool/CLI output. If needed, generate it withsequenzy urlsor MCPget_app_urls. - Call out implementation caveats that matter operationally, such as
whoamiusing cached local auth state, sequence creation supporting both--goaland explicit step modes, generated sequences being capped at 10 emails,campaigns testbeing a stubbed success path in the current backend, and conditional email content requiring block JSON rather than raw HTML.
Dashboard URLs
Use SEQUENZY_APP_URL as the dashboard base when it is set; otherwise default to https://sequenzy.com.
Prefer actual URLs returned by the CLI/MCP result:
- sequence editor:
/dashboard/company/{companyId}/sequences/{sequenceId} - campaign editor:
/dashboard/company/{companyId}/campaign/{campaignId} - template/email editor:
/dashboard/company/{companyId}/emails/{emailId} - settings:
/dashboard/company/{companyId}/settings - settings tab:
/dashboard/company/{companyId}/settings?tab={tab}
Useful settings tabs include domain, tracking, localization, integrations, events, tags, goals, sync-rules, api-keys, widgets, and team.
References
- references/command-reference.md: exact command shapes, env vars, behavior, and caveats.
- references/use-cases.md: decision trees and examples for the most common agent tasks.