Set Up Codex

Codex connects to Citlyze over remote Streamable HTTP with a bearer token read from an environment variable. Create the API key in workspace settings first.

Add the server

Export the key in the shell profile Codex runs from:

export CITLYZE_API_KEY="aeo_live_..."

Then register the server with the Codex CLI:

codex mcp add citlyze \
  --url https://app.citlyze.com/api/mcp \
  --bearer-token-env-var CITLYZE_API_KEY

This writes the equivalent of the following to ~/.codex/config.toml, which you can also edit directly:

[mcp_servers.citlyze]
url = "https://app.citlyze.com/api/mcp"
bearer_token_env_var = "CITLYZE_API_KEY"

Codex sends the variable's value as Authorization: Bearer ... on every request. Older Codex builds that only support local stdio servers can use the mcp-remote bridge shown in Set Up MCP Clients.

Verify the connection

Run codex mcp list and confirm citlyze appears, then ask a simple read-only question in a Codex session:

Show my Citlyze workspace overview.

If the key is valid and the plan includes API exports, the agent should call get_workspace_overview.

Key handling

Create a dedicated API key for Codex so it can be revoked without affecting dashboards or other integrations. Keep the key in the environment variable; avoid pasting it into config.toml directly.

For other MCP clients, see Set Up MCP Clients.