Skip to main content
The CLI connects to the Ringee MCP server. It needs one thing: the URL of that server for your workspace.

Get your connection details

From the dashboard, open Settings → MCP / Integrations, or call the API while signed in:

Environment variables

string
The full SSE URL. Preferred — takes precedence over everything else.
string
Your Ringee API base URL. Used together with RINGEE_USER_ID when RINGEE_MCP_URL is not set.
string
Your Ringee user UUID.
string
Organization UUID, to start in an organization workspace instead of your personal one.
string
Optional bearer token sent as an Authorization header.
RINGEE_BACKEND_URL tolerates a trailing /api — the CLI strips it before building the path, so both https://api.ringee.io and https://api.ringee.io/api work.
The MCP URL is a credential for that workspace. Keep it in your shell profile or secret manager, not in a committed .env or a shared script.

Verify

config check is the fastest way to answer “is my Ringee connection working?” — if it prints tools, every other command will work, and so will any MCP client pointed at the same URL.

Choosing a workspace

The URL sets your starting workspace, but it is not a lock. Anything that changes the active workspace — the dashboard switcher, an assistant calling switch_workspace — applies to the CLI too, because the active workspace is stored server-side.
Seeing results you did not expect? Your active workspace has probably changed. See Workspaces.

Errors

Next steps

Command reference

Every command, argument and flag

Use it from an agent

Give a shell-capable agent access to Ringee