> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ringee.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

> Point the ringee CLI at your workspace

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:

```http theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
GET /api/mcp/connection-info
```

```json theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
{
  "mode": "freelancer",
  "userId": "a91c…",
  "organizationId": null,
  "url": "https://api.ringee.io/api/mcp/a91c…/sse"
}
```

## Environment variables

**RINGEE\_MCP\_URL** `string`

The full SSE URL. **Preferred** — takes precedence over everything else.

**RINGEE\_BACKEND\_URL** `string`

Your Ringee API base URL. Used together with `RINGEE_USER_ID` when `RINGEE_MCP_URL` is not set.

**RINGEE\_USER\_ID** `string`

Your Ringee user UUID.

**RINGEE\_ORG\_ID** `string`

Organization UUID, to start in an organization workspace instead of your personal one.

**RINGEE\_API\_KEY** `string`

Optional bearer token sent as an `Authorization` header.

```bash Full URL (preferred) theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
export RINGEE_MCP_URL="https://api.ringee.io/api/mcp/<userId>/sse"
```

```bash Organization workspace theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
export RINGEE_MCP_URL="https://api.ringee.io/api/mcp/<userId>/<organizationId>/sse"
```

```bash Built from parts theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
export RINGEE_BACKEND_URL="https://api.ringee.io"
export RINGEE_USER_ID="<userId>"
export RINGEE_ORG_ID="<organizationId>"   # optional
```

```bash Self-hosted theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
export RINGEE_BACKEND_URL="https://ringee-api.example.com"
export RINGEE_USER_ID="<userId>"
```

> [!NOTE]
>
> `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.

> [!WARNING]
>
> 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

```bash theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
ringee config show    # resolved connection, token masked
ringee config check   # connect and list every tool the server exposes
```

`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.

> [!TIP]
>
> Seeing results you did not expect? Your active workspace has probably changed. See [Workspaces](https://docs.ringee.io/mcp/workspaces.md).

## Errors

| Message | Fix |
| - | - |
| `Missing Ringee connection config` | Set `RINGEE_MCP_URL`, or `RINGEE_BACKEND_URL` **and** `RINGEE_USER_ID`. |
| Connection refused or timeout | Confirm the backend is reachable from this machine and the URL includes `/api/mcp/…/sse`. |
| Empty tool list from `config check` | The URL resolved but the ids do not match a real user or organization. Re-run `GET /api/mcp/connection-info`. |

## Next steps

> [card] [Command reference](https://docs.ringee.io/cli/commands.md)
>
> Every command, argument and flag

> [card] [Use it from an agent](https://docs.ringee.io/cli/agents.md)
>
> Give a shell-capable agent access to Ringee


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.