Docs/Candor Deploy

Deploy from Codex: connect the Candor MCP

Connect OpenAI Codex to Candor Deploy so you can say 'deploy this to Candor' from the Codex CLI or IDE extension — sign in once, no token to copy.

Candor Deploy runs an MCP server at https://api.candorhost.app/mcp. Codex talks MCP, so once it’s connected you can tell it to deploy an app and it does — detects the stack, provisions any databases, and hands back the live URL.

Connecting is a sign-in: Codex sends you to Candor, you sign in the way you do for the portal, pick the project the agent may deploy to, and approve.

Codex CLI

Two commands — add the server, then sign in:

codex mcp add candor --url https://api.candorhost.app/mcp
codex mcp login candor

The login opens a browser for the Candor sign-in; approve, and Codex stores the credential. codex mcp list shows the server with its auth status, and /mcp inside the codex TUI lists what’s active. Then: deploy this repo to Candor.

That writes to ~/.codex/config.toml. To keep it per project instead, put the same thing in .codex/config.toml at the repo root:

[mcp_servers.candor]
url = "https://api.candorhost.app/mcp"

Codex IDE extension

Open the Codex panel’s settings, choose Add server, name it candor, pick Streamable HTTP, and enter https://api.candorhost.app/mcp. The extension runs the same sign-in.

Codex in ChatGPT on the web doesn’t read local Codex configuration, so it can’t reach Candor this way; use the CLI or the IDE extension.

Using a token instead

For CI or a machine with no browser, an API token works in place of the sign-in. In the portal, open Account → API tokens → Create token (or a project’s own tokens page for a token confined to that project), copy it, and put it in an environment variable Codex reads:

[mcp_servers.candor]
url = "https://api.candorhost.app/mcp"
bearer_token_env_var = "CANDOR_TOKEN"

Set CANDOR_TOKEN in the shell that launches Codex. The token never lands in the config file.

What you can ask

  • Deploy a repo — “deploy github.com/me/myapp to Candor.” Push your latest commit first; Candor builds from your git remote.
  • Create a service in a project, set or list its environment variables, then redeploy so they apply.
  • Check a deploy — the phase, and the build logs if it failed.
  • List what you’ve deployed — projects, services and their URLs — and who you are: the account and plan limits the connection acts under.

What the connection can do, and revoking it

Approving gives Codex developer access to one project — the one you picked. It can deploy, configure and read logs there; it can’t touch other projects, members, or billing. Behind the scenes it holds a project API token, listed with that project’s tokens in the portal; revoke it there and the connection stops working immediately.

Something here wrong, unclear, or missing? Tell us — docs get fixed like bugs.