> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gateway.connexease.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Codex Plugin

This guide covers installation, skill selection, example responses, and update steps for using the Connexease Gateway Customer MCP with Codex CLI or Codex desktop on macOS.

For explanations of the five shared workflows, security rules, and troubleshooting, see the \[Introduction and Shared Usage Guide]\(Connexease Gateway - Introduction.md).

## Setup and usage

Requirements: **macOS**, **Node.js 20+**, Codex CLI or Codex desktop, internet access, and your own Gateway account for panel operations. If you use Codex CLI, run the following in Terminal:

```bash theme={null}
codex plugin marketplace add connexease/connexease-gateway-customer-mcp
codex plugin add connexease-gateway-ops@connexease-gateway-customer-mcp
codex plugin list
codex
```

| Terminal command | What does it do? |
| - | - |
| `codex plugin marketplace add connexease/connexease-gateway-customer-mcp` | Introduces the plugin catalog in the repository to Codex; it does not install the plugin by itself. |
| `codex plugin add connexease-gateway-ops@connexease-gateway-customer-mcp` | Installs the documentation skills and local `gateway-account` MCP panel tools. |
| `codex plugin list` | Checks the installed/enabled plugin name and version. If the output is long, filter it with `--marketplace connexease-gateway-customer-mcp`. |
| `codex` | Starts the Codex CLI chat; enter the `$...` examples in this chat's message field. |

The same marketplace can be used in Codex desktop. Check the installed plugin in the application's **Plugins** section and open a new chat if necessary. The installed package contains the `ask`, `connect`, `panel-ops`, `sandbox-ops`, and `insights` skills, as well as the `gateway-account` MCP tools.

Do not use Claude's `/connexease-gateway-ops:...` commands in Codex. Type `$` in the message field to select an installed skill; the names below correspond to the plugin's five skills. Codex may also select the appropriate skill based on your request.

| In the Codex message field | What does it do? | Is Gateway sign-in required? |
| - | - | - |
| `$connexease-gateway-ops:ask <question>` | Requests an answer verified against live official documentation and backed by sources; it does not perform account operations. \[Details]\(Connexease Gateway - Introduction.md#ask-asking-documentation-questions). | No |
| `$connexease-gateway-ops:connect` | Connects to the Gateway account you select through local macOS windows and lists its applications. \[Details]\(Connexease Gateway - Introduction.md#connect-connecting-to-an-account). | This command is the sign-in flow |
| `$connexease-gateway-ops:panel-ops <request>` | Reads supported panel data or makes changes with your explicit approval. \[Details]\(Connexease Gateway - Introduction.md#panel-ops-panel-operations). | Yes, for account-specific operations |
| `$connexease-gateway-ops:sandbox-ops <request>` | Manages test numbers and real sandbox sends through preview and approval. \[Details]\(Connexease Gateway - Introduction.md#sandbox-ops-test-numbers-and-messages). | Yes |
| `$connexease-gateway-ops:insights <request>` | Requests a single Insight view/chart or a comparison of two periods. \[Details]\(Connexease Gateway - Introduction.md#insights-tables-charts-and-comparisons). | Yes |

Examples — enter these **in the Codex session's message field**, not in the terminal shell:

```text theme={null}
$connexease-gateway-ops:ask How does Sandbox is_fake work? Include the official documentation link.
$connexease-gateway-ops:connect
$connexease-gateway-ops:panel-ops Show the webhook status of the application I select.
$connexease-gateway-ops:sandbox-ops Show the test numbers; preview the message before sending it.
$connexease-gateway-ops:insights Compare two date ranges for Messages Over Time.
```

### Codex: command → example response

These lines are intended for the **Codex CLI/desktop message field**. You can choose the relevant skill from the skill picker that opens when you type `$`. Responses are illustrative; a similar flow is expected when the local macOS windows and account API succeed.

```text theme={null}
› $connexease-gateway-ops:ask Give me the link to the Quickstart documentation.
• Official Quickstart: https://docs.gateway.connexease.com/quickstart

› $connexease-gateway-ops:connect
• Complete the macOS sign-in windows.
• Connection successful: test@example.com. Accessible application: Demo Application (WhatsApp).

› $connexease-gateway-ops:panel-ops Show the webhook status of Demo Application; do not change it.
• The webhook is enabled for Demo Application. URL: https://example.com/webhook.
  Only the current status was read; no changes were made.

› $connexease-gateway-ops:sandbox-ops Preview the text "Hello" to the registered test number in Demo Application before sending it.
• Preview — recipient: +905321234567; message: Hello; status: not_sent.
  No message has been sent yet. Would you like me to actually send this message?

› $connexease-gateway-ops:insights Show Demo Application's Messages Over Time view for September 1–3, 2026.
• Only the Messages Over Time table and terminal line chart were displayed.
  Example daily values: Sep 1: 4, Sep 2: 7, Sep 3: 9 messages.
```

If the skill name appears differently in your client, select the relevant skill shown under `connexease-gateway-ops` in the `$` picker; you can also make the request in natural language. `$` is not a shell variable; it is the skill picker **in the Codex message field**. Sign-in and sensitive information are handled in local macOS windows. Real changes require chat approval and a separate local approval. Check availability in the installed client version of Codex desktop; the source catalog may also appear in the desktop application's Plugins section. This **local Codex integration** is not automatically added to ChatGPT web chat. OpenAI's [local marketplace guide](https://developers.openai.com/plugins/build/plugins) provides details.

When a new version is released, refresh the catalog and check the installed version with these commands in a regular Terminal:

```bash theme={null}
codex plugin marketplace upgrade connexease-gateway-customer-mcp
codex plugin list --marketplace connexease-gateway-customer-mcp
```

The first command **refreshes the marketplace source**; do not assume that it upgrades the installed package by itself. If the list still shows the old version, update it from Codex's Plugins section or, depending on the installation state, follow the `codex plugin add connexease-gateway-ops@connexease-gateway-customer-mcp` flow. Check the version again and open a new session. If the marketplace has not yet been added, use the initial setup steps above. Enter `/exit` or press `Ctrl+C` to leave the CLI.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.