Can I use Agora as a CLI?

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

Can I expose Agora through MCP?

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

Where are Agora credentials stored?

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

Can I deny write access for Agora MCP tools?

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

communication

Agora CLI for AI Agents

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

Agora CLI Setup

Agora can be configured headlessly with `kosmokrator integrations:configure agora`.

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

Call Agora Headlessly

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

kosmo integrations:call agora.agora_list_projects '{}' --json

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

kosmo integrations:agora agora_list_projects '{}' --json

Agent Discovery Commands

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

kosmo integrations:docs agora --json
kosmo integrations:docs agora.agora_list_projects --json
kosmo integrations:schema agora.agora_list_projects --json
kosmo integrations:search "Agora" --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 Agora.

`agora.agora_list_projects`

Read read

List all Agora projects. Returns project IDs, names, and their current status.

Parameters: none

Generic CLI call

kosmo integrations:call agora.agora_list_projects '{}' --json

Provider shortcut

kosmo integrations:agora agora_list_projects '{}' --json

`agora.agora_get_project`

Read read

Get details of a specific Agora project by ID, including its name, App ID, App Certificate, and status.

Parameters: project_id

Generic CLI call

kosmo integrations:call agora.agora_get_project '{"project_id":"example_project_id"}' --json

Provider shortcut

kosmo integrations:agora agora_get_project '{"project_id":"example_project_id"}' --json

`agora.agora_create_project`

Write write

Create a new Agora project. Specify a project name and optional configuration such as recording settings and authentication mode.

Parameters: name, recording_config, sign_key

Generic CLI call

kosmo integrations:call agora.agora_create_project '{"name":"example_name","recording_config":"example_recording_config","sign_key":true}' --json

Provider shortcut

kosmo integrations:agora agora_create_project '{"name":"example_name","recording_config":"example_recording_config","sign_key":true}' --json

`agora.agora_list_recordings`

Read read

List cloud recordings from Agora with optional filters. Supports filtering by channel name, resource ID, and time range.

Parameters: cname, resource_id, limit, start_ts, end_ts

Generic CLI call

kosmo integrations:call agora.agora_list_recordings '{"cname":"example_cname","resource_id":"example_resource_id","limit":1,"start_ts":1,"end_ts":1}' --json

Provider shortcut

kosmo integrations:agora agora_list_recordings '{"cname":"example_cname","resource_id":"example_resource_id","limit":1,"start_ts":1,"end_ts":1}' --json

`agora.agora_get_recording`

Read read

Get details of a specific Agora cloud recording by its session ID (sid), including status, file list, and download URLs.

Parameters: recording_id

Generic CLI call

kosmo integrations:call agora.agora_get_recording '{"recording_id":"example_recording_id"}' --json

Provider shortcut

kosmo integrations:agora agora_get_recording '{"recording_id":"example_recording_id"}' --json

`agora.agora_start_recording`

Write write

Start a cloud recording for an Agora channel. Specify the channel name, UID, and recording configuration such as container format, storage settings, and layout.

Parameters: cname, uid, clientRequest

Generic CLI call

kosmo integrations:call agora.agora_start_recording '{"cname":"example_cname","uid":"example_uid","clientRequest":"example_clientRequest"}' --json

Provider shortcut

kosmo integrations:agora agora_start_recording '{"cname":"example_cname","uid":"example_uid","clientRequest":"example_clientRequest"}' --json

`agora.agora_get_current_user`

Read read

Get information about the current authenticated Agora user.

Parameters: none

Generic CLI call

kosmo integrations:call agora.agora_get_current_user '{}' --json

Provider shortcut

kosmo integrations:agora agora_get_current_user '{}' --json

Function Schemas

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

`agora.agora_list_projects`

List all Agora projects. Returns project IDs, names, and their current status.

Operation: Read read
Schema command: kosmo integrations:schema agora.agora_list_projects --json

Parameter	Type	Required	Description
No parameters.

`agora.agora_get_project`

Get details of a specific Agora project by ID, including its name, App ID, App Certificate, and status.

Operation: Read read
Schema command: kosmo integrations:schema agora.agora_get_project --json

Parameter	Type	Required	Description
`project_id`	string	yes	The project ID.

`agora.agora_create_project`

Create a new Agora project. Specify a project name and optional configuration such as recording settings and authentication mode.

Operation: Write write
Schema command: kosmo integrations:schema agora.agora_create_project --json

Parameter	Type	Required	Description
`name`	string	yes	A unique name for the project.
`recording_config`	object	no	Recording configuration as a JSON object (e.g., {"max_idle_time": 30, "stream_types": 2}).
`sign_key`	boolean	no	Whether to enable a signaling key for the project (default: false).

`agora.agora_list_recordings`

List cloud recordings from Agora with optional filters. Supports filtering by channel name, resource ID, and time range.

Operation: Read read
Schema command: kosmo integrations:schema agora.agora_list_recordings --json

Parameter	Type	Required	Description
`cname`	string	no	Filter recordings by channel name.
`resource_id`	string	no	Filter by resource ID.
`limit`	integer	no	Maximum number of recordings to return (default: 20).
`start_ts`	integer	no	Unix timestamp to filter recordings starting after this time.
`end_ts`	integer	no	Unix timestamp to filter recordings ending before this time.

`agora.agora_get_recording`

Get details of a specific Agora cloud recording by its session ID (sid), including status, file list, and download URLs.

Operation: Read read
Schema command: kosmo integrations:schema agora.agora_get_recording --json

Parameter	Type	Required	Description
`recording_id`	string	yes	The recording session ID (sid).

`agora.agora_start_recording`

Start a cloud recording for an Agora channel. Specify the channel name, UID, and recording configuration such as container format, storage settings, and layout.

Operation: Write write
Schema command: kosmo integrations:schema agora.agora_start_recording --json

Parameter	Type	Required	Description
`cname`	string	yes	The channel name to record.
`uid`	string	yes	The user ID of the recording client in the channel.
`clientRequest`	object	no	Recording configuration including recordingConfig and storageConfig (e.g., {"recordingConfig": {"maxIdleTime": 30, "streamTypes": 2}, "storageConfig": {"vendor": 1, "region": 0, "bucket": "my-bucket", "accessKey": "...", "secretKey": "...", "fileNamePrefix": ["recording"]}}).

`agora.agora_get_current_user`

Get information about the current authenticated Agora user.

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