Can I use Whereby as a CLI?

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

Can I expose Whereby through MCP?

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

Where are Whereby credentials stored?

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

Can I deny write access for Whereby MCP tools?

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

communication

Whereby CLI for AI Agents

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

7 functions 5 read 2 write Bearer token auth

Submit Whereby feedback View package source

Whereby CLI Setup

Whereby can be configured headlessly with `kosmokrator integrations:configure whereby`.

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

Credentials

Authentication type: Bearer token bearer_token. 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
`access_token`	`WHEREBY_ACCESS_TOKEN`	Secret `secret`	yes	API Key
`url`	`WHEREBY_URL`	URL `url`	no	API Base URL

Call Whereby Headlessly

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

kosmo integrations:call whereby.whereby_list_rooms '{
  "limit": 1,
  "cursor": "example_cursor"
}' --json

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

kosmo integrations:whereby whereby_list_rooms '{
  "limit": 1,
  "cursor": "example_cursor"
}' --json

Agent Discovery Commands

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

kosmo integrations:docs whereby --json
kosmo integrations:docs whereby.whereby_list_rooms --json
kosmo integrations:schema whereby.whereby_list_rooms --json
kosmo integrations:search "Whereby" --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 Whereby.

`whereby.whereby_list_rooms`

Read read

List Whereby rooms with optional pagination and filtering.

Parameters: limit, cursor

Generic CLI call

kosmo integrations:call whereby.whereby_list_rooms '{"limit":1,"cursor":"example_cursor"}' --json

Provider shortcut

kosmo integrations:whereby whereby_list_rooms '{"limit":1,"cursor":"example_cursor"}' --json

`whereby.whereby_get_room`

Read read

Get detailed information about a specific Whereby room, including meeting URL, configuration, and host details.

Parameters: room_name

Generic CLI call

kosmo integrations:call whereby.whereby_get_room '{"room_name":"example_room_name"}' --json

Provider shortcut

kosmo integrations:whereby whereby_get_room '{"room_name":"example_room_name"}' --json

`whereby.whereby_create_room`

Write write

Create a new Whereby video meeting room with optional configuration such as room mode, time limits, and participant settings.

Parameters: room_mode, room_name_prefix, start_date, end_date, fields

Generic CLI call

kosmo integrations:call whereby.whereby_create_room '{"room_mode":"example_room_mode","room_name_prefix":"example_room_name_prefix","start_date":"example_start_date","end_date":"example_end_date","fields":"example_fields"}' --json

Provider shortcut

kosmo integrations:whereby whereby_create_room '{"room_mode":"example_room_mode","room_name_prefix":"example_room_name_prefix","start_date":"example_start_date","end_date":"example_end_date","fields":"example_fields"}' --json

`whereby.whereby_delete_room`

Write write

Delete a Whereby room by its name. This action is permanent and cannot be undone.

Parameters: room_name

Generic CLI call

kosmo integrations:call whereby.whereby_delete_room '{"room_name":"example_room_name"}' --json

Provider shortcut

kosmo integrations:whereby whereby_delete_room '{"room_name":"example_room_name"}' --json

`whereby.whereby_list_meetings`

Read read

List past Whereby meetings with optional pagination and date filtering.

Parameters: limit, cursor, from_date, to_date, room_name

Generic CLI call

kosmo integrations:call whereby.whereby_list_meetings '{"limit":1,"cursor":"example_cursor","from_date":"example_from_date","to_date":"example_to_date","room_name":"example_room_name"}' --json

Provider shortcut

kosmo integrations:whereby whereby_list_meetings '{"limit":1,"cursor":"example_cursor","from_date":"example_from_date","to_date":"example_to_date","room_name":"example_room_name"}' --json

`whereby.whereby_get_meeting`

Read read

Get detailed information about a specific past Whereby meeting, including participants, duration, and recording status.

Parameters: meeting_id

Generic CLI call

kosmo integrations:call whereby.whereby_get_meeting '{"meeting_id":"example_meeting_id"}' --json

Provider shortcut

kosmo integrations:whereby whereby_get_meeting '{"meeting_id":"example_meeting_id"}' --json

`whereby.whereby_get_current_user`

Read read

Get the profile information of the currently authenticated Whereby user, including account details and plan information.

Parameters: none

Generic CLI call

kosmo integrations:call whereby.whereby_get_current_user '{}' --json

Provider shortcut

kosmo integrations:whereby whereby_get_current_user '{}' --json

Function Schemas

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

`whereby.whereby_list_rooms`

List Whereby rooms with optional pagination and filtering.

Operation: Read read
Schema command: kosmo integrations:schema whereby.whereby_list_rooms --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of rooms to return.
`cursor`	string	no	Pagination cursor for fetching the next page of results.

`whereby.whereby_get_room`

Get detailed information about a specific Whereby room, including meeting URL, configuration, and host details.

Operation: Read read
Schema command: kosmo integrations:schema whereby.whereby_get_room --json

Parameter	Type	Required	Description
`room_name`	string	yes	The unique name or identifier of the Whereby room.

`whereby.whereby_create_room`

Create a new Whereby video meeting room with optional configuration such as room mode, time limits, and participant settings.

Operation: Write write
Schema command: kosmo integrations:schema whereby.whereby_create_room --json

Parameter	Type	Required	Description
`room_mode`	string	no	Room mode, e.g. "normal" or "group".
`room_name_prefix`	string	no	Optional prefix for the generated room name.
`start_date`	string	no	ISO 8601 start date/time for the room.
`end_date`	string	no	ISO 8601 end date/time for the room.
`fields`	array	no	Additional room configuration fields such as lockRoomOnJoin, recording, etc.

`whereby.whereby_delete_room`

Delete a Whereby room by its name. This action is permanent and cannot be undone.

Operation: Write write
Schema command: kosmo integrations:schema whereby.whereby_delete_room --json

Parameter	Type	Required	Description
`room_name`	string	yes	The unique name or identifier of the Whereby room to delete.

`whereby.whereby_list_meetings`

List past Whereby meetings with optional pagination and date filtering.

Operation: Read read
Schema command: kosmo integrations:schema whereby.whereby_list_meetings --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of meetings to return.
`cursor`	string	no	Pagination cursor for fetching the next page of results.
`from_date`	string	no	ISO 8601 start date to filter meetings from.
`to_date`	string	no	ISO 8601 end date to filter meetings to.
`room_name`	string	no	Filter meetings by room name.

`whereby.whereby_get_meeting`

Get detailed information about a specific past Whereby meeting, including participants, duration, and recording status.

Operation: Read read
Schema command: kosmo integrations:schema whereby.whereby_get_meeting --json

Parameter	Type	Required	Description
`meeting_id`	string	yes	The unique identifier of the meeting.

`whereby.whereby_get_current_user`

Get the profile information of the currently authenticated Whereby user, including account details and plan information.

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