Welcome to Zuora Product Documentation

Explore our rich library of product information

Install Zuora MCP server in OpenAI Codex CLI for desktop clients

Learn how to install and configure the Zuora MCP server in the OpenAI Codex CLI so you can connect to your Zuora tenant using MCP.

Review the prerequisites and ensure that you have created an OAuth token and obtained the required credentials. For more detailed information, see Create OAuth Credentials for local MCP client.

The OpenAI Codex CLI supports MCP server integration through configuration settings. After installation, you can configure the Zuora MCP server to enable interaction with your Zuora tenant.

  1. To install the Codex CLI, run the following command:
    
    npm i -g @openai/codex
            
  2. Launch Codex at least once and complete any initial authentication. Then close the application before continuing.
  3. To update the Codex configuration file, open the ~/.codex/config.toml file and add the following configuration:
    
    [mcp_servers.zuora-mcp]
    command = "npx"
    args = ["-y", "zuora-mcp"]
    
    [mcp_servers.zuora-mcp.env]
    ZUORA_BASE_URL = "https://rest.apisandbox.zuora.com"
    ZUORA_CLIENT_ID = "your-client-id"
    ZUORA_CLIENT_SECRET = "your-client-secret"
            
  4. Replace the placeholders with your values:
    • ZUORA_CLIENT_ID: Your OAuth client ID.
    • ZUORA_CLIENT_SECRET: Your OAuth client secret.
  5. Save the file and restart the Codex CLI.
  6. To verify the MCP server configuration, run /mcp and confirm that the Zuora MCP server is listed.

The Zuora MCP server is configured in Codex CLI and is ready to use.