Install and Connect APIXO MCP

Install APIXO MCP in Cursor, Claude Code, Codex, or another MCP client, then connect through browser sign-in and device approval.

This guide uses the normal local setup path: install MCP → call apixo_setup → sign in and approve in your browser → call apixo_finish_setup → use APIXO tools. You do not need to create, copy, or paste an API key for this flow.

Before you start

• Node.js >= 20 and npm >= 9 (the server runs with npx)
• An MCP-compatible client, such as Cursor, Claude Code, Codex CLI, Claude Desktop, Windsurf, Cline, Continue, or Zed
• A browser where you can sign in to your APIXO account and approve the device

The package is @apixo/mcp-server. npx -y @apixo/mcp-server downloads the current release when needed; you do not install it globally.

Step 1: Register the MCP server

Register the server without APIXO_API_KEY. The browser setup in the next step creates and stores the credential for this installation.

Cursor

Open or create ~/.cursor/mcp.json (Windows: %USERPROFILE%\.cursor\mcp.json) and add an entry under mcpServers:

{
  "mcpServers": {
    "apixo": {
      "command": "npx",
      "args": ["-y", "@apixo/mcp-server"],
      "env": {
        "APIXO_MCP_CLIENT_TYPE": "cursor"
      }
    }
  }
}

Claude Code

Run this in a terminal. The trailing -- separates the Claude Code command from the MCP server command:

claude mcp add --env APIXO_MCP_CLIENT_TYPE=claudeCli apixo -- npx -y @apixo/mcp-server

Claude Code defaults to local scope. Add --scope user to make the server available across your projects, or --scope project for a committable project configuration.

Codex CLI

Run this in a terminal:

codex mcp add apixo -- npx -y @apixo/mcp-server

You should see a message similar to Added global MCP server 'apixo'.

If codex is not recognized, see CLI not found on PATH.

Other MCP clients

Most MCP clients load stdio servers from a JSON configuration with this shape. Add the apixo entry under the mcpServers object required by your client:

{
  "mcpServers": {
    "apixo": {
      "command": "npx",
      "args": ["-y", "@apixo/mcp-server"],
      "env": {
        "APIXO_MCP_CLIENT_TYPE": "generic"
      }
    }
  }
}

Common config locations:

Client	Config file
Claude Desktop (macOS)	~/Library/Application Support/Claude/claude_desktop_config.json
Claude Desktop (Windows)	%APPDATA%\Claude\claude_desktop_config.json
Windsurf	~/.codeium/windsurf/mcp_config.json
Cline / Continue / Zed	Configure from each client’s MCP settings UI

Use your client’s documentation if its config location differs. APIXO_MCP_CLIENT_TYPE is an optional label that makes this device easier to recognize in the APIXO Dashboard; use a short identifier for your client or omit the env block to use generic.

Step 2: Start browser setup

Reload or restart your MCP client so it launches the new server. In a new conversation, ask the client to call the setup tool:

Use the apixo MCP tool apixo_setup to connect this installation to my APIXO account. For Codex, set client_type to codexCli.

apixo_setup opens the verification URL in your browser when possible. If it cannot open a browser, use the verification_url returned by the tool.

Step 3: Sign in and approve the device

In the browser, sign in to APIXO if prompted, review the device approval request, and approve it. Return to the same MCP client conversation after the browser confirms success.

The API key created for this installation is kept in the MCP server’s private local credential store. It is not shown in the browser-setup tool response or in your chat.

Step 4: Finish setup

Ask the client to complete the pending approval:

Use the apixo MCP tool apixo_finish_setup now.

If the browser approval is still pending, finish it in the browser and call apixo_finish_setup again. A successful response reports that the local installation is configured; it does not reveal the credential.

Step 5: Verify and use the tools

First, check that the MCP registration is present:

Claude Code

claude mcp list
claude mcp get apixo

Codex CLI

codex mcp get apixo

Other clients

Open the client’s MCP or Tools settings and confirm that apixo is connected. If it does not appear, reload the client once more.

Then try one of these prompts:

Use only the apixo MCP tools. List the available image models and show the input schema for one model you recommend for a product image.

Use only the apixo MCP tools. Explain how to submit a batch, reconcile a failed item,
and verify the signed webhook. Do not create any tasks or reveal a webhook secret.

This read-only prompt should call apixo_get_batch_integration_guide. Review the guide before using apixo_submit_batch or apixo_get_batch_status in your application.

Use only the apixo MCP tools. What is the current balance for this APIXO installation?

The returned balance is specific to your account.

For generation, ask the agent to look up the schema first and put any production API call in your server-side application code. Do not expose an API key in browser-delivered code.

Revoke a device connection

To formally disconnect an MCP installation, open Dashboard → API Keys and revoke the device key whose name follows this format:

MCP/{clientType}/{hostLabel}/{installationId}

This Dashboard action is the server-side revocation. It prevents that device key from authorizing future API calls. The MCP server’s local credential file is only a local copy used by this machine; deleting it is local cleanup, not a Dashboard logout or server-side revocation.

After revoking a device key, complete browser setup again to connect a new device key. See Troubleshooting if the client continues to use a stale local credential.

Advanced: manually supply APIXO_API_KEY

Use this only when browser approval is not practical: CI, another browserless environment, or local development debugging. An explicitly configured APIXO_API_KEY takes precedence over the browser-created local credential.

For example, a CI-only server configuration can include the secret in its environment:

{
  "mcpServers": {
    "apixo": {
      "command": "npx",
      "args": ["-y", "@apixo/mcp-server"],
      "env": {
        "APIXO_API_KEY": "provided-by-your-secret-manager"
      }
    }
  }
}

Keep this value in your CI secret manager or local development environment. Do not commit it, put it in a shared project configuration, or paste it into chat.

Next steps

What APIXO MCP can do

Browse the tool overview and MCP capabilities.

Troubleshooting

Fix browser setup, Node.js, and client connection problems.

Generation API reference

Learn the REST task flow your application will call in production.

Browse models

Explore model capabilities and inputs.