Can I use MessageBird as a CLI?

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

Can I expose MessageBird through MCP?

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

Where are MessageBird credentials stored?

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

Can I deny write access for MessageBird MCP tools?

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

messaging

MessageBird CLI for AI Agents

Use the MessageBird CLI from KosmoKrator to call MessageBird 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 MessageBird feedback View package source

MessageBird CLI Setup

MessageBird can be configured headlessly with `kosmokrator integrations:configure messagebird`.

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

Call MessageBird Headlessly

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

kosmo integrations:call messagebird.messagebird_send_sms '{
  "originator": "example_originator",
  "recipients": "example_recipients",
  "body": "example_body"
}' --json

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

kosmo integrations:messagebird messagebird_send_sms '{
  "originator": "example_originator",
  "recipients": "example_recipients",
  "body": "example_body"
}' --json

Agent Discovery Commands

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

kosmo integrations:docs messagebird --json
kosmo integrations:docs messagebird.messagebird_send_sms --json
kosmo integrations:schema messagebird.messagebird_send_sms --json
kosmo integrations:search "MessageBird" --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 MessageBird.

`messagebird.messagebird_send_sms`

Write write

Send an SMS message to one or more recipients via MessageBird. Specify a sender (originator), one or more phone numbers, and the message body.

Parameters: originator, recipients, body

Generic CLI call

kosmo integrations:call messagebird.messagebird_send_sms '{"originator":"example_originator","recipients":"example_recipients","body":"example_body"}' --json

Provider shortcut

kosmo integrations:messagebird messagebird_send_sms '{"originator":"example_originator","recipients":"example_recipients","body":"example_body"}' --json

`messagebird.messagebird_get_message`

Read read

Retrieve details of a specific MessageBird message by its ID, including status, recipient info, and delivery timestamps.

Parameters: id

Generic CLI call

kosmo integrations:call messagebird.messagebird_get_message '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:messagebird messagebird_get_message '{"id":"example_id"}' --json

`messagebird.messagebird_list_messages`

Read read

List sent and received messages from MessageBird. Supports filtering by status and direction, with pagination.

Parameters: limit, offset, status, direction

Generic CLI call

kosmo integrations:call messagebird.messagebird_list_messages '{"limit":1,"offset":1,"status":"example_status","direction":"example_direction"}' --json

Provider shortcut

kosmo integrations:messagebird messagebird_list_messages '{"limit":1,"offset":1,"status":"example_status","direction":"example_direction"}' --json

`messagebird.messagebird_list_balance`

Read read

Check your MessageBird account balance. Returns the available amount and payment type (prepaid or postpaid).

Parameters: none

Generic CLI call

kosmo integrations:call messagebird.messagebird_list_balance '{}' --json

Provider shortcut

kosmo integrations:messagebird messagebird_list_balance '{}' --json

`messagebird.messagebird_list_numbers`

Read read

List purchased phone numbers in your MessageBird account. Supports filtering by country code and number type.

Parameters: limit, offset, country_code, number_type

Generic CLI call

kosmo integrations:call messagebird.messagebird_list_numbers '{"limit":1,"offset":1,"country_code":"example_country_code","number_type":"example_number_type"}' --json

Provider shortcut

kosmo integrations:messagebird messagebird_list_numbers '{"limit":1,"offset":1,"country_code":"example_country_code","number_type":"example_number_type"}' --json

`messagebird.messagebird_get_current_user`

Read read

Get the current MessageBird account information, including balance and payment type.

Parameters: none

Generic CLI call

kosmo integrations:call messagebird.messagebird_get_current_user '{}' --json

Provider shortcut

kosmo integrations:messagebird messagebird_get_current_user '{}' --json

Function Schemas

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

`messagebird.messagebird_send_sms`

Send an SMS message to one or more recipients via MessageBird. Specify a sender (originator), one or more phone numbers, and the message body.

Operation: Write write
Schema command: kosmo integrations:schema messagebird.messagebird_send_sms --json

Parameter	Type	Required	Description
`originator`	string	yes	Sender name or phone number (e.g., "OpenCompany" or "+3197012345678"). Max 11 characters for alphanumeric, or a valid phone number.
`recipients`	array	yes	Array of recipient phone numbers in international format (e.g., ["+31612345678", "+447912345678"]).
`body`	string	yes	The SMS text message body. Max 160 characters for a single SMS; longer messages are concatenated and charged accordingly.

`messagebird.messagebird_get_message`

Retrieve details of a specific MessageBird message by its ID, including status, recipient info, and delivery timestamps.

Operation: Read read
Schema command: kosmo integrations:schema messagebird.messagebird_get_message --json

Parameter	Type	Required	Description
`id`	string	yes	The message ID (e.g., "a6e89f50c0d25b35a212345678901234").

`messagebird.messagebird_list_messages`

List sent and received messages from MessageBird. Supports filtering by status and direction, with pagination.

Operation: Read read
Schema command: kosmo integrations:schema messagebird.messagebird_list_messages --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of messages to return (default: 20, max: 1000).
`offset`	integer	no	Offset for pagination (default: 0).
`status`	string	no	Filter by message status: scheduled, sent, buffered, delivered, expired, delivery_failed.
`direction`	string	no	Filter by direction: mt (outgoing / mobile terminated), mo (incoming / mobile originated).

`messagebird.messagebird_list_balance`

Check your MessageBird account balance. Returns the available amount and payment type (prepaid or postpaid).

Operation: Read read
Schema command: kosmo integrations:schema messagebird.messagebird_list_balance --json

Parameter	Type	Required	Description
No parameters.

`messagebird.messagebird_list_numbers`

List purchased phone numbers in your MessageBird account. Supports filtering by country code and number type.

Operation: Read read
Schema command: kosmo integrations:schema messagebird.messagebird_list_numbers --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of numbers to return (default: 20).
`offset`	integer	no	Offset for pagination (default: 0).
`country_code`	string	no	Filter by ISO 3166-1 alpha-2 country code (e.g., "NL", "US", "GB").
`number_type`	string	no	Filter by number type: mobile, landline.

`messagebird.messagebird_get_current_user`

Get the current MessageBird account information, including balance and payment type.

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