Can I use Novu as a CLI?

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

Can I expose Novu through MCP?

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

Where are Novu credentials stored?

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

Can I deny write access for Novu MCP tools?

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

communication

Novu CLI for AI Agents

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

7 functions 5 read 2 write API key auth

Submit Novu feedback View package source

Novu CLI Setup

Novu can be configured headlessly with `kosmokrator integrations:configure novu`.

# 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 novu --set api_key="$NOVU_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor novu --json
kosmokrator integrations:status --json

Credentials

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

Key	Env var	Type	Required	Label
`api_key`	`NOVU_API_KEY`	Secret `secret`	yes	API Key
`url`	`NOVU_URL`	URL `url`	no	Novu API URL

Call Novu Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call novu.novu_list_notifications '{
  "page": 1,
  "limit": 1,
  "channel": "example_channel"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:novu novu_list_notifications '{
  "page": 1,
  "limit": 1,
  "channel": "example_channel"
}' --json

Agent Discovery Commands

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

kosmo integrations:docs novu --json
kosmo integrations:docs novu.novu_list_notifications --json
kosmo integrations:schema novu.novu_list_notifications --json
kosmo integrations:search "Novu" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Novu.

`novu.novu_list_notifications`

Read read

List notifications from Novu. Returns a paginated list of notifications, optionally filtered by channel (e.g., in_app, email, sms, chat, push).

Parameters: page, limit, channel

Generic CLI call

kosmo integrations:call novu.novu_list_notifications '{"page":1,"limit":1,"channel":"example_channel"}' --json

Provider shortcut

kosmo integrations:novu novu_list_notifications '{"page":1,"limit":1,"channel":"example_channel"}' --json

`novu.novu_get_notification`

Read read

Get details of a specific notification in Novu by its ID. Returns the full notification object including status, channel data, and content.

Parameters: id

Generic CLI call

kosmo integrations:call novu.novu_get_notification '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:novu novu_get_notification '{"id":"example_id"}' --json

`novu.novu_list_subscribers`

Read read

List subscribers from Novu. Returns a paginated list of all notification subscribers with their details.

Parameters: page, limit

Generic CLI call

kosmo integrations:call novu.novu_list_subscribers '{"page":1,"limit":1}' --json

Provider shortcut

kosmo integrations:novu novu_list_subscribers '{"page":1,"limit":1}' --json

`novu.novu_get_subscriber`

Read read

Get details of a specific subscriber in Novu by their ID. Returns the subscriber profile including email, phone, and preferences.

Parameters: id

Generic CLI call

kosmo integrations:call novu.novu_get_subscriber '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:novu novu_get_subscriber '{"id":"example_id"}' --json

`novu.novu_create_subscriber`

Write write

Create a new subscriber in Novu. Requires an email address. Optionally include first name, last name, and phone number.

Parameters: email, firstName, lastName, phone

Generic CLI call

kosmo integrations:call novu.novu_create_subscriber '{"email":"example_email","firstName":"example_firstName","lastName":"example_lastName","phone":"example_phone"}' --json

Provider shortcut

kosmo integrations:novu novu_create_subscriber '{"email":"example_email","firstName":"example_firstName","lastName":"example_lastName","phone":"example_phone"}' --json

`novu.novu_trigger_event`

Write write

Trigger a notification event in Novu. Sends a notification based on a workflow template to one or more subscribers. The "to" field can be a subscriber ID, email address, or an array of recipients.

Parameters: name, to, payload

Generic CLI call

kosmo integrations:call novu.novu_trigger_event '{"name":"example_name","to":"example_to","payload":"example_payload"}' --json

Provider shortcut

kosmo integrations:novu novu_trigger_event '{"name":"example_name","to":"example_to","payload":"example_payload"}' --json

`novu.novu_get_current_user`

Read read

Get the currently authenticated Novu user. Returns user profile information including name, email, and organization details.

Parameters: none

Generic CLI call

kosmo integrations:call novu.novu_get_current_user '{}' --json

Provider shortcut

kosmo integrations:novu novu_get_current_user '{}' --json

Function Schemas

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

`novu.novu_list_notifications`

List notifications from Novu. Returns a paginated list of notifications, optionally filtered by channel (e.g., in_app, email, sms, chat, push).

Operation: Read read
Schema command: kosmo integrations:schema novu.novu_list_notifications --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (1-based, default: 1).
`limit`	integer	no	Number of notifications per page (default: 10, max: 100).
`channel`	string	no	Filter by notification channel. Options: in_app, email, sms, chat, push.

`novu.novu_get_notification`

Get details of a specific notification in Novu by its ID. Returns the full notification object including status, channel data, and content.

Operation: Read read
Schema command: kosmo integrations:schema novu.novu_get_notification --json

Parameter	Type	Required	Description
`id`	string	yes	The notification ID.

`novu.novu_list_subscribers`

List subscribers from Novu. Returns a paginated list of all notification subscribers with their details.

Operation: Read read
Schema command: kosmo integrations:schema novu.novu_list_subscribers --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (0-based, default: 0).
`limit`	integer	no	Number of subscribers per page (default: 10, max: 100).

`novu.novu_get_subscriber`

Get details of a specific subscriber in Novu by their ID. Returns the subscriber profile including email, phone, and preferences.

Operation: Read read
Schema command: kosmo integrations:schema novu.novu_get_subscriber --json

Parameter	Type	Required	Description
`id`	string	yes	The subscriber ID.

`novu.novu_create_subscriber`

Create a new subscriber in Novu. Requires an email address. Optionally include first name, last name, and phone number.

Operation: Write write
Schema command: kosmo integrations:schema novu.novu_create_subscriber --json

Parameter	Type	Required	Description
`email`	string	yes	The subscriber's email address.
`firstName`	string	no	The subscriber's first name.
`lastName`	string	no	The subscriber's last name.
`phone`	string	no	The subscriber's phone number (e.g., "+1234567890").

`novu.novu_trigger_event`

Trigger a notification event in Novu. Sends a notification based on a workflow template to one or more subscribers. The "to" field can be a subscriber ID, email address, or an array of recipients.

Operation: Write write
Schema command: kosmo integrations:schema novu.novu_trigger_event --json

Parameter	Type	Required	Description
`name`	string	yes	The workflow trigger key / template name (e.g., "onboarding-welcome").
`to`	string	yes	Recipient — a subscriber ID, email address, or JSON-encoded array of recipient identifiers.
`payload`	object	no	Key-value pairs to pass as template variables (e.g., {"name": "John", "plan": "Pro"}).

`novu.novu_get_current_user`

Get the currently authenticated Novu user. Returns user profile information including name, email, and organization details.

Operation: Read read
Schema command: kosmo integrations:schema novu.novu_get_current_user --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.