Getting Started

Connect your agent

Wire Claude Code, Cursor, Codex, or VS Code to nyxory over MCP — one endpoint, OAuth on first connect, no token to paste.

MCP (Model Context Protocol) is the contract layer between your coding agent and nyxory. Any MCP-speaking client can plug in. There is one endpoint and one auth mechanism, and each client needs one small step to register it.

  • Endpoint: https://api.nyxory.com/mcp (Streamable HTTP)
  • Auth: OAuth on first connect — the client opens a browser and your human approves. No token to generate or paste for interactive use.

Every MCP-speaking coding agent works. Jump to yours:

The fastest path: nyx setup

One command installs the nyx CLI, signs your human in, detects the MCP-capable clients on the machine (Claude Code, Cursor, Codex, VS Code, Claude Desktop), and registers nyxory with each one.

curl -fsSL https://nyxory.com/install.sh | bash    # macOS / Linux / WSL
irm https://nyxory.com/install.ps1 | iex           # Windows PowerShell

The installer runs nyx setup for you. To re-run it later — it’s idempotent and leaves your other MCP servers untouched:

nyx setup            # pick the clients to wire, interactively
nyx setup --all      # wire every detected client, no prompts

Wire a specific client

If you only use one editor, register nyxory there directly. Each command below writes the client’s own config at its own path — you never hand-edit a config file.

Claude Code

nyx claude install

This calls Claude Code’s own CLI (claude mcp add) to register nyxory as a remote HTTP endpoint. To do it without nyx:

claude mcp add --transport http --scope user nyxory https://api.nyxory.com/mcp

Cursor

nyx cursor install

Writes the nyxory server into ~/.cursor/mcp.json (or ./.cursor/mcp.json with --scope local), merging alongside any servers already there.

Codex

nyx codex install

Adds an [mcp_servers.nyxory] block to ~/.codex/config.toml, then runs codex mcp login nyxory to complete OAuth — Codex won’t prompt for it on its own, so this step is required.

VS Code

nyx vscode install

Writes an http-transport entry into VS Code’s user mcp.json (~/Library/Application Support/Code/User/mcp.json on macOS, %APPDATA%\Code\User\mcp.json on Windows, ~/.config/Code/User/mcp.json on Linux).

Claude Desktop

Claude Desktop connects through your claude.ai account, not a local file. Run nyx setup and it opens the connectors page — or add a custom connector pointing at https://api.nyxory.com/mcp yourself.

Any other MCP client

nyxory speaks standard MCP over HTTP. Point your client at the endpoint:

{
  "mcpServers": {
    "nyxory": {
      "url": "https://api.nyxory.com/mcp"
    }
  }
}

A tools/list call returns the authoritative surface. The tools are catalogued in the MCP tools reference; the workspace and build primitives are described in Builds & the execution surface.

Authentication

Interactive setups need no token: every client runs its own OAuth handshake against the endpoint the first time it connects, and your human approves in the browser.

For headless or CI use, mint a long-lived token on a signed-in machine and send it as a bearer:

nyx token create my-ci-runner
# → prints the plaintext ONCE — store it as a secret

Rotate with nyx token delete <id> followed by another create. See the CLI reference for the full nyx token surface.

Verify it’s wired

Ask your agent to list its MCP tools (in Claude Code: /mcp). You should see nyxory with, at minimum:

  • nyx_brain and nyx_ping
  • nyx_shell, nyx_read_file / nyx_write_file / nyx_edit_file, nyx_set_secret
  • nyx_build_and_push_image, nyx_deploy_manifests
  • nyx_app_*, nyx_project_*, nyx_domain_*, nyx_token_*, nyx_github_*

The cheapest live check: ask the agent to call nyx_ping — it returns your user ID, which confirms the OAuth round-trip worked.

Next: run the Quickstart. Deploying private GitHub repos? That’s a one-time GitHub App install — see Deploy from a private repo.

Caution: If it doesn’t connect, three things go wrong most often. Wrong URL — it’s api.nyxory.com/mcp, not api.nyxory.app (that’s where deployed apps live). OAuth not completed — for Codex, make sure codex mcp login nyxory finished in the browser; for the others, reopen the client so it re-triggers the approval. MCP transport disabled — check that MCP is enabled in your client’s settings.

Ask any AI about nyxory