EmailOctopus MCP, CLI, and Lua Integration for AI Agents
EmailOctopus integration docs for AI agents: MCP gateway setup, EmailOctopus CLI commands, Lua API reference, credentials, and function schemas.
6 functions 5 read 1 write API key auth
EmailOctopus for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Machine-Readable Metadata
- integration_slug
email-octopus- route_slug
email-octopus- package
email-octopus- auth_strategy
api_keyAPI key- cli_setup_supported
true- cli_runtime_supported
true- mcp_gateway_supported
true- lua_supported
true- supports_multi_account
true
Quick Links
Lua APIAgent-facing namespace and function reference. EmailOctopus CLIHeadless setup and direct function calls. EmailOctopus MCPMCP gateway setup for external clients. Submit feedbackReport missing tools, auth problems, wrong docs, or runtime issues. ContributeAdd tools or improve metadata in the integrations repo.
EmailOctopus MCP Client Matrix
Use these pages when a specific agent client or framework needs copy-pasteable MCP setup for EmailOctopus.
Claude Code EmailOctopus MCP setup for Claude Code. Cursor EmailOctopus MCP setup for Cursor. Codex EmailOctopus MCP setup for Codex. OpenAI Agents EmailOctopus MCP setup for OpenAI Agents SDK. Claude Agent SDK EmailOctopus MCP setup for Claude Agent SDK. Vercel AI SDK EmailOctopus MCP setup for Vercel AI SDK. LangChain EmailOctopus MCP setup for LangChain. LangGraph EmailOctopus MCP setup for LangGraph. CrewAI EmailOctopus MCP setup for CrewAI. MCP clients EmailOctopus MCP setup for Generic MCP Clients.
EmailOctopus CLI Matrix
Use these pages for direct EmailOctopus CLI workflows in scripts, CI, cron, and agent wrappers.
CI EmailOctopus CLI for CI. Cron Jobs EmailOctopus CLI for cron jobs. Shell Scripts EmailOctopus CLI for shell scripts. Headless Automation EmailOctopus CLI for headless automation. Coding Agents EmailOctopus CLI for coding agents.
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
email-octopus.emailoctopus_list_contacts | Read read | 4 | List contacts in an EmailOctopus mailing list. Returns contact email addresses, statuses, and pagination cursors. |
email-octopus.emailoctopus_get_contact | Read read | 2 | Get details of a specific contact in an EmailOctopus mailing list, including email address, status, and custom fields. |
email-octopus.emailoctopus_create_contact | Write write | 4 | Add a new contact to an EmailOctopus mailing list. Requires an email address. |
email-octopus.emailoctopus_list_campaigns | Read read | 3 | List all email campaigns in your EmailOctopus account, including their status, subject, and send dates. |
email-octopus.emailoctopus_get_campaign | Read read | 1 | Get details of a specific EmailOctopus campaign, including status, subject, content, and delivery statistics. |
email-octopus.emailoctopus_get_current_user | Read read | 0 | Get the authenticated EmailOctopus account details, including name and email address. |