Can I use EmailOctopus as a CLI?

Yes. KosmoKrator exposes a EmailOctopus CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose EmailOctopus through MCP?

Yes. The KosmoKrator MCP gateway can expose selected EmailOctopus tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are EmailOctopus credentials stored?

EmailOctopus credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for EmailOctopus MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

productivity

EmailOctopus CLI for AI Agents

Use the EmailOctopus CLI from KosmoKrator to call EmailOctopus tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

EmailOctopus CLI Setup

EmailOctopus can be configured headlessly with `kosmokrator integrations:configure email-octopus`.

Install, configure, and verify

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure email-octopus --set api_key="$EMAIL_OCTOPUS_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor email-octopus --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

Key	Env var	Type	Required	Label
`api_key`	`EMAIL_OCTOPUS_API_KEY`	Secret `secret`	yes	API Key
`url`	`EMAIL_OCTOPUS_URL`	URL `url`	no	API Base URL
`list_id`	`EMAIL_OCTOPUS_LIST_ID`	Text `string`	no	Default List ID

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call email-octopus.emailoctopus_list_lists '{}' --json

Provider shortcut

kosmo integrations:email-octopus emailoctopus_list_lists '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs email-octopus --json
kosmo integrations:docs email-octopus.emailoctopus_list_lists --json
kosmo integrations:schema email-octopus.emailoctopus_list_lists --json
kosmo integrations:search "EmailOctopus" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`email-octopus.emailoctopus_list_lists`

List EmailOctopus mailing lists.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_list_lists '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_list_lists '{}' --json

`email-octopus.emailoctopus_get_list`

Get one mailing list.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_list '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_list '{}' --json

`email-octopus.emailoctopus_create_list`

Create a mailing list.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_create_list '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_create_list '{}' --json

`email-octopus.emailoctopus_update_list`

Update a mailing list.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_update_list '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_update_list '{}' --json

`email-octopus.emailoctopus_delete_list`

Delete a mailing list.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_delete_list '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_delete_list '{}' --json

`email-octopus.emailoctopus_list_tags`

List list tags.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_list_tags '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_list_tags '{}' --json

`email-octopus.emailoctopus_create_tag`

Create a list tag.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_create_tag '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_create_tag '{}' --json

`email-octopus.emailoctopus_update_tag`

Update a list tag.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_update_tag '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_update_tag '{}' --json

`email-octopus.emailoctopus_delete_tag`

Delete a list tag.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_delete_tag '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_delete_tag '{}' --json

`email-octopus.emailoctopus_list_contacts`

List contacts in a mailing list.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_list_contacts '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_list_contacts '{}' --json

`email-octopus.emailoctopus_list_subscribed_contacts`

List subscribed contacts.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_list_subscribed_contacts '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_list_subscribed_contacts '{}' --json

`email-octopus.emailoctopus_list_unsubscribed_contacts`

List unsubscribed contacts.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_list_unsubscribed_contacts '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_list_unsubscribed_contacts '{}' --json

`email-octopus.emailoctopus_list_tagged_contacts`

List contacts by tag.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_list_tagged_contacts '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_list_tagged_contacts '{}' --json

`email-octopus.emailoctopus_get_contact`

Get one list contact.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_contact '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_contact '{}' --json

`email-octopus.emailoctopus_create_contact`

Create a list contact.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_create_contact '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_create_contact '{}' --json

`email-octopus.emailoctopus_update_contact`

Update one list contact.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_update_contact '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_update_contact '{}' --json

`email-octopus.emailoctopus_delete_contact`

Delete one list contact.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_delete_contact '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_delete_contact '{}' --json

`email-octopus.emailoctopus_update_contacts_bulk`

Update up to 100 contacts.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_update_contacts_bulk '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_update_contacts_bulk '{}' --json

`email-octopus.emailoctopus_create_field`

Create a list field.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_create_field '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_create_field '{}' --json

`email-octopus.emailoctopus_update_field`

Update a list field.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_update_field '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_update_field '{}' --json

`email-octopus.emailoctopus_delete_field`

Delete a list field.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_delete_field '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_delete_field '{}' --json

`email-octopus.emailoctopus_list_campaigns`

List campaigns.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_list_campaigns '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_list_campaigns '{}' --json

`email-octopus.emailoctopus_get_campaign`

Get one campaign.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign '{}' --json

`email-octopus.emailoctopus_get_campaign_report_summary`

Get the campaign summary report.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign_report_summary '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign_report_summary '{}' --json

`email-octopus.emailoctopus_get_campaign_report_links`

Get the campaign links report.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign_report_links '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign_report_links '{}' --json

`email-octopus.emailoctopus_get_campaign_report_bounced`

Get campaign bounced contacts.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign_report_bounced '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign_report_bounced '{}' --json

`email-octopus.emailoctopus_get_campaign_report_clicked`

Get campaign clicked contacts.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign_report_clicked '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign_report_clicked '{}' --json

`email-octopus.emailoctopus_get_campaign_report_complained`

Get campaign complained contacts.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign_report_complained '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign_report_complained '{}' --json

`email-octopus.emailoctopus_get_campaign_report_opened`

Get campaign opened contacts.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign_report_opened '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign_report_opened '{}' --json

`email-octopus.emailoctopus_get_campaign_report_sent`

Get campaign sent contacts.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign_report_sent '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign_report_sent '{}' --json

`email-octopus.emailoctopus_get_campaign_report_unsubscribed`

Get campaign unsubscribed contacts.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign_report_unsubscribed '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign_report_unsubscribed '{}' --json

`email-octopus.emailoctopus_get_campaign_report_not_clicked`

Get contacts who did not click a campaign.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign_report_not_clicked '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign_report_not_clicked '{}' --json

`email-octopus.emailoctopus_get_campaign_report_not_opened`

Get contacts who did not open a campaign.

Read read

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_get_campaign_report_not_opened '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_get_campaign_report_not_opened '{}' --json

`email-octopus.emailoctopus_start_automation`

Start an automation for a contact.

Write write

Parameters: none

Generic call

kosmo integrations:call email-octopus.emailoctopus_start_automation '{}' --json

Shortcut

kosmo integrations:email-octopus emailoctopus_start_automation '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

email-octopus.emailoctopus_list_lists 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_list_lists --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_list 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_list --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_create_list 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_create_list --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_update_list 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_update_list --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_delete_list 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_delete_list --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_list_tags 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_list_tags --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_create_tag 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_create_tag --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_update_tag 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_update_tag --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_delete_tag 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_delete_tag --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_list_contacts 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_list_contacts --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_list_subscribed_contacts 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_list_subscribed_contacts --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_list_unsubscribed_contacts 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_list_unsubscribed_contacts --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_list_tagged_contacts 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_list_tagged_contacts --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_contact 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_contact --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_create_contact 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_create_contact --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_update_contact 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_update_contact --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_delete_contact 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_delete_contact --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_update_contacts_bulk 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_update_contacts_bulk --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_create_field 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_create_field --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_update_field 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_update_field --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_delete_field 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_delete_field --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_list_campaigns 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_list_campaigns --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign_report_summary 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign_report_summary --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign_report_links 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign_report_links --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign_report_bounced 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign_report_bounced --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign_report_clicked 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign_report_clicked --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign_report_complained 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign_report_complained --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign_report_opened 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign_report_opened --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign_report_sent 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign_report_sent --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign_report_unsubscribed 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign_report_unsubscribed --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign_report_not_clicked 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign_report_not_clicked --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_get_campaign_report_not_opened 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_get_campaign_report_not_opened --json

Parameter	Type	Required	Description
No parameters.

email-octopus.emailoctopus_start_automation 0 parameters

Schema command

kosmo integrations:schema email-octopus.emailoctopus_start_automation --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.