The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Lumail listing page.
Install Lumail's agent skills or connect Lumail to Claude Code and Codex. The repository includes reusable marketing and copywriting skills alongside the Lumail CLI and OAuth MCP plugin skills.
Agent plugins authenticate with browser OAuth. Those sessions have no API
token to create, paste, or store. The WordPress plugin in wordpress/ is
the exception: it uses a lum_ organization token on the server.
The fastest path is to let your agent do it. Paste this into Claude Code:
or into Codex:
or, for the terminal workflow (full API, including sending), into any agent:
Prefer to run it yourself:
Full guides: docs/claude-code-install.md · docs/codex-install.md
| Path | What it is |
|---|---|
wordpress/ | WordPress plugin — [lumail_form] → Lumail subscribers |
.claude-plugin/marketplace.json | Claude Code marketplace descriptor |
claude/.claude-plugin/plugin.json | Claude Code plugin, declares the MCP server inline |
codex/.codex-plugin/plugin.json | Codex plugin metadata |
codex/.mcp.json | Codex MCP server configuration |
.agents/plugins/marketplace.json | Codex marketplace descriptor |
skills/lumail/ | The lumail CLI skill (npx lumail) — canonical copy |
skills/lumail-plugin/ | How to drive the MCP connection, its limits and errors |
skills/marketing/ | Marketing strategy, positioning, offers, funnels, and launches |
skills/copywritting/ | Conversion copy for emails, pages, ads, scripts, and CTAs |
claude/skills and codex/skills are real copies of skills/ (symlinks break
on Windows checkouts), so both hosts ship the same skills. Edit the
top-level skills/ first, then sync the copies.
The plugin points both hosts at https://lumail.io/mcp, an OAuth 2.1 protected
resource. The host registers itself through dynamic client registration, runs
PKCE, and stores the access token itself. During the browser flow you sign in,
pick which organization the agent may reach, and approve the scopes. Only
owners and admins of an organization can authorize it.
Access tokens carry the organization as a claim, so a session can never reach another organization in your account. Revoke from the connected-apps list in Lumail settings and access stops on the next request, with no local config to clean up.
Read — subscribers, tags, campaigns, campaign analytics and progress, workflows and workflow groups, org stats, subscriber growth, senders, custom fields, snippets, writing style.
Write — add subscribers, create and apply tags, create and edit campaign drafts, duplicate campaigns, create and configure workflow drafts.
Not available over OAuth — sending, scheduling, publishing or activating a
workflow, unsubscribing, and every delete. Those tools are not registered on
this endpoint, so an agent cannot reach them even with your approval. Do that
work in the Lumail app, or with npx lumail if you want it in a terminal.
npx lumail reaches the full API, including sending. It authenticates with the
same browser flow:
The lumail skill in this repository teaches agents the whole CLI.
wordpress/ is a PHP plugin: settings page for a lum_ token, shortcode
[lumail_form], server-side POST /api/v2/subscribers. Copy the folder to
wp-content/plugins/lumail. Details: wordpress/README.md
and wordpress/BUILD.md.
How did last week's newsletter perform compared to the one before?Draft a launch campaign with three subject line options.Add user@example.com to my newsletter and tag them vip.Build a three-email welcome sequence over a week and leave it as a draft.Show me subscriber growth over the last 30 days.MIT licensed.