Can I use VBout as a CLI?

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

Can I expose VBout through MCP?

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

Where are VBout credentials stored?

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

Can I deny write access for VBout MCP tools?

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

marketing

VBout CLI for AI Agents

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

6 functions 5 read 1 write API key auth

Submit VBout feedback View package source

VBout CLI Setup

VBout can be configured headlessly with `kosmokrator integrations:configure vbout`.

# 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 vbout --set api_key="$VBOUT_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor vbout --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`	`VBOUT_API_KEY`	Secret `secret`	yes	API Key
`url`	`VBOUT_URL`	URL `url`	no	API Base URL

Call VBout Headlessly

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

kosmo integrations:call vbout.vbout_list_contacts '{
  "limit": 1,
  "offset": 1
}' --json

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

kosmo integrations:vbout vbout_list_contacts '{
  "limit": 1,
  "offset": 1
}' --json

Agent Discovery Commands

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

kosmo integrations:docs vbout --json
kosmo integrations:docs vbout.vbout_list_contacts --json
kosmo integrations:schema vbout.vbout_list_contacts --json
kosmo integrations:search "VBout" --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 VBout.

`vbout.vbout_list_contacts`

Read read

List contacts from VBout. Returns paginated contact records including email, name, and list membership.

Parameters: limit, offset

Generic CLI call

kosmo integrations:call vbout.vbout_list_contacts '{"limit":1,"offset":1}' --json

Provider shortcut

kosmo integrations:vbout vbout_list_contacts '{"limit":1,"offset":1}' --json

`vbout.vbout_get_contact`

Read read

Get details for a specific VBout contact by ID, including email, name, custom fields, and list memberships.

Parameters: id

Generic CLI call

kosmo integrations:call vbout.vbout_get_contact '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:vbout vbout_get_contact '{"id":"example_id"}' --json

`vbout.vbout_create_contact`

Write write

Add a new contact to a VBout email list. Requires an email address and a list ID. Optionally pass additional fields like first name, last name, or custom fields.

Parameters: email, list_id, first_name, last_name, phone

Generic CLI call

kosmo integrations:call vbout.vbout_create_contact '{"email":"example_email","list_id":"example_list_id","first_name":"example_first_name","last_name":"example_last_name","phone":"example_phone"}' --json

Provider shortcut

kosmo integrations:vbout vbout_create_contact '{"email":"example_email","list_id":"example_list_id","first_name":"example_first_name","last_name":"example_last_name","phone":"example_phone"}' --json

`vbout.vbout_list_campaigns`

Read read

List email campaigns from VBout. Returns paginated campaign records including subject, status, and send statistics.

Parameters: limit, offset

Generic CLI call

kosmo integrations:call vbout.vbout_list_campaigns '{"limit":1,"offset":1}' --json

Provider shortcut

kosmo integrations:vbout vbout_list_campaigns '{"limit":1,"offset":1}' --json

`vbout.vbout_get_campaign`

Read read

Get details for a specific VBout email campaign by ID, including subject, content, status, and delivery statistics.

Parameters: id

Generic CLI call

kosmo integrations:call vbout.vbout_get_campaign '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:vbout vbout_get_campaign '{"id":"example_id"}' --json

`vbout.vbout_get_current_user`

Read read

Get the currently authenticated VBout user profile. Useful for verifying API credentials and retrieving account information.

Parameters: none

Generic CLI call

kosmo integrations:call vbout.vbout_get_current_user '{}' --json

Provider shortcut

kosmo integrations:vbout vbout_get_current_user '{}' --json

Function Schemas

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

`vbout.vbout_list_contacts`

List contacts from VBout. Returns paginated contact records including email, name, and list membership.

Operation: Read read
Schema command: kosmo integrations:schema vbout.vbout_list_contacts --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of contacts to return (default: 20, max: 100).
`offset`	integer	no	Offset for pagination (default: 0).

`vbout.vbout_get_contact`

Get details for a specific VBout contact by ID, including email, name, custom fields, and list memberships.

Operation: Read read
Schema command: kosmo integrations:schema vbout.vbout_get_contact --json

Parameter	Type	Required	Description
`id`	string	yes	The VBout contact ID.

`vbout.vbout_create_contact`

Add a new contact to a VBout email list. Requires an email address and a list ID. Optionally pass additional fields like first name, last name, or custom fields.

Operation: Write write
Schema command: kosmo integrations:schema vbout.vbout_create_contact --json

Parameter	Type	Required	Description
`email`	string	yes	The contact's email address.
`list_id`	string	yes	The VBout list ID to add the contact to.
`first_name`	string	no	Contact's first name.
`last_name`	string	no	Contact's last name.
`phone`	string	no	Contact's phone number.

`vbout.vbout_list_campaigns`

List email campaigns from VBout. Returns paginated campaign records including subject, status, and send statistics.

Operation: Read read
Schema command: kosmo integrations:schema vbout.vbout_list_campaigns --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of campaigns to return (default: 20, max: 100).
`offset`	integer	no	Offset for pagination (default: 0).

`vbout.vbout_get_campaign`

Get details for a specific VBout email campaign by ID, including subject, content, status, and delivery statistics.

Operation: Read read
Schema command: kosmo integrations:schema vbout.vbout_get_campaign --json

Parameter	Type	Required	Description
`id`	string	yes	The VBout campaign ID.

`vbout.vbout_get_current_user`

Get the currently authenticated VBout user profile. Useful for verifying API credentials and retrieving account information.

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