Can I use UpCloud as a CLI?

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

Can I expose UpCloud through MCP?

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

Where are UpCloud credentials stored?

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

Can I deny write access for UpCloud MCP tools?

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

productivity

UpCloud CLI for AI Agents

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

UpCloud CLI Setup

UpCloud can be configured headlessly with `kosmokrator integrations:configure upcloud`.

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 upcloud --set access_token="$UPCLOUD_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor upcloud --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

Key	Env var	Type	Required	Label
`access_token`	`UPCLOUD_ACCESS_TOKEN`	Secret `secret`	yes	API Token
`url`	`UPCLOUD_URL`	URL `url`	no	API Base URL

Command Patterns

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

Generic CLI call

kosmo integrations:call upcloud.upcloud_list_servers '{}' --json

Provider shortcut

kosmo integrations:upcloud upcloud_list_servers '{}' --json

Discovery

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

Discovery commands

kosmo integrations:docs upcloud --json
kosmo integrations:docs upcloud.upcloud_list_servers --json
kosmo integrations:schema upcloud.upcloud_list_servers --json
kosmo integrations:search "UpCloud" --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.

`upcloud.upcloud_list_servers`

List all cloud servers on the UpCloud account.

Read read

Parameters: none

Generic call

kosmo integrations:call upcloud.upcloud_list_servers '{}' --json

Shortcut

kosmo integrations:upcloud upcloud_list_servers '{}' --json

`upcloud.upcloud_get_server`

Get details for a specific UpCloud server by UUID.

Read read

Parameters: uuid

Generic call

kosmo integrations:call upcloud.upcloud_get_server '{"uuid":"example_uuid"}' --json

Shortcut

kosmo integrations:upcloud upcloud_get_server '{"uuid":"example_uuid"}' --json

`upcloud.upcloud_list_storages`

List storage devices on the UpCloud account. Optionally filter by type (disk, backup, cdrom).

Read read

Parameters: type

Generic call

kosmo integrations:call upcloud.upcloud_list_storages '{"type":"example_type"}' --json

Shortcut

kosmo integrations:upcloud upcloud_list_storages '{"type":"example_type"}' --json

`upcloud.upcloud_list_networks`

List private networks on the UpCloud account.

Read read

Parameters: none

Generic call

kosmo integrations:call upcloud.upcloud_list_networks '{}' --json

Shortcut

kosmo integrations:upcloud upcloud_list_networks '{}' --json

`upcloud.upcloud_list_ips`

List IP addresses on the UpCloud account.

Read read

Parameters: none

Generic call

kosmo integrations:call upcloud.upcloud_list_ips '{}' --json

Shortcut

kosmo integrations:upcloud upcloud_list_ips '{}' --json

`upcloud.upcloud_list_zones`

List available UpCloud zones (data centers).

Read read

Parameters: none

Generic call

kosmo integrations:call upcloud.upcloud_list_zones '{}' --json

Shortcut

kosmo integrations:upcloud upcloud_list_zones '{}' --json

`upcloud.upcloud_get_current_user`

Get the profile of the currently authenticated UpCloud user. Useful for verifying credentials and displaying account information.

Read read

Parameters: none

Generic call

kosmo integrations:call upcloud.upcloud_get_current_user '{}' --json

Shortcut

kosmo integrations:upcloud upcloud_get_current_user '{}' --json

Function Schemas

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

upcloud.upcloud_list_servers 0 parameters

Schema command

kosmo integrations:schema upcloud.upcloud_list_servers --json

Parameter	Type	Required	Description
No parameters.

upcloud.upcloud_get_server 1 parameters

Schema command

kosmo integrations:schema upcloud.upcloud_get_server --json

Parameter	Type	Required	Description
`uuid`	string	yes	The server UUID.

upcloud.upcloud_list_storages 1 parameters

Schema command

kosmo integrations:schema upcloud.upcloud_list_storages --json

Parameter	Type	Required	Description
`type`	string	no	Storage type filter: "disk", "backup", or "cdrom".

upcloud.upcloud_list_networks 0 parameters

Schema command

kosmo integrations:schema upcloud.upcloud_list_networks --json

Parameter	Type	Required	Description
No parameters.

upcloud.upcloud_list_ips 0 parameters

Schema command

kosmo integrations:schema upcloud.upcloud_list_ips --json

Parameter	Type	Required	Description
No parameters.

upcloud.upcloud_list_zones 0 parameters

Schema command

kosmo integrations:schema upcloud.upcloud_list_zones --json

Parameter	Type	Required	Description
No parameters.

upcloud.upcloud_get_current_user 0 parameters

Schema command

kosmo integrations:schema upcloud.upcloud_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.