> ## 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.

# Introduction

This introductory guide explains what the Connexease Gateway Customer MCP provides, where to enter its commands, how approvals and security work, and how to use its five shared workflows. For client-specific installation and examples, use the separate Claude Code, Codex, or Gemini CLI guide.

**Where should each command be entered?** Enter the `claude plugin ...`, `codex plugin ...`, and `gemini extensions ...` lines in the macOS **Terminal** application. Enter `/connexease-...`, `$connexease-...`, and `/connexease-gateway:...` requests **in the message field of the relevant AI session after opening it**. You do not need to repeat the launch commands for every question.

**Status of example responses:** The “Command → example response” blocks below are **illustrative scenarios**, not records of tests performed on a real account or fixed verbatim outputs. `test@example.com`, “Demo Application,” the phone number, and the Insight figures are fictional. Actual responses vary depending on your account, API environment, the documentation available that day, and the AI client's wording. In particular, reaching the “Would you like me to send it?” question in an example **does not mean that a message was sent**.

| Environment | Questions based on official Gateway documentation | Connect to a Gateway account and perform panel operations |
| - | - | - |
| Claude Code (macOS) | Yes | Yes; supported operations also require user approval |
| Codex CLI / Codex desktop (macOS) | Yes | Yes; with local MCP tools and user approval |
| Gemini CLI (macOS) | Yes | Yes; with the local extension and user approval |
| ChatGPT, Gemini, or Claude web chat | Not automatically added by this GitHub installation | No |

> **Verification status:** For version 0.11.0, 89 automated tests, Claude manifest validation, and source/packaged MCP tool discovery passed. Sign-in with a real account, local macOS windows, and live panel operations have not yet been verified end to end in Codex and Gemini CLI. Therefore, test the initial setup and operations with your account in a controlled manner. Publication on GitHub does not mean that the plugin is listed in AI providers' public plugin marketplaces.

If you previously installed a plugin from the personal `gateway-connexease-ai-plugin` source, it will not automatically migrate to the new Connexease source. Review the old installation separately to avoid enabling the same functionality from two sources; this guide does not automatically remove the old installation. The `connexease-gateway-ops` skill/command names have not changed.

## 2. Detailed usage guide for the five commands

The examples below use **Claude Code syntax** for readability. In Codex, enter the same request as `$connexease-gateway-ops:<command>`; in Gemini CLI, use `/connexease-gateway:<command>`. For example, Claude's `/connexease-gateway-ops:insights ...` request becomes `$connexease-gateway-ops:insights ...` in Codex and `/connexease-gateway:insights ...` in Gemini. These are AI messages, not direct API calls or shell commands. Replace the application name and dates in each request with values appropriate for your account.

### `ask`: asking documentation questions

**Purpose:** Read current official pages at `docs.gateway.connexease.com` and answer the question with verified links. This is suitable for topics such as Quickstart, the dashboard, WhatsApp Messaging API, Public API, authentication, and the Embedded Signup SDK. It **does not sign in to a Gateway account, read panel data, or send messages.**

**How to write the request:** Enter one or more clear questions after the `ask` command. If you specifically want a documentation link, example request, or an explanation of which condition applies, say so. If the documentation is unavailable, the assistant must not invent an unverified API field or link.

```text theme={null}
/connexease-gateway-ops:ask How can I test a sandbox API request with is_fake? Include a verified documentation link and a complete cURL example.
/connexease-gateway-ops:ask What is the difference between the Public API and an application API key? Include links to the two relevant pages.
/connexease-gateway-ops:ask What steps are required to initialize the Embedded Signup SDK? Use official documentation only.
```

### `connect`: connecting to an account

**Purpose:** Sign in with the Connexease Gateway account you select and display the applications that account can access. The user's macOS, GitHub, or AI account email **does not need to match the Gateway account**.

**Flow:** Enter the command by itself, then enter the email address and secret password in the local windows that open. Do not enter them in the chat. On success, the assistant displays the connected account address and the application list. If the application list fails to load because of a separate API error, it reports sign-in success or failure separately. If Keychain storage fails, the session may last only while the AI client remains open. To switch to a different Gateway account, start the `connect` flow again.

```text theme={null}
/connexease-gateway-ops:connect
```

### `panel-ops`: panel operations

**Purpose:** Read supported panel information or change it **with your explicit approval**. When possible, specify the application/organization name, the operation to perform, and the field to change. If multiple applications match, you will be asked to choose one. Read requests display data; for write requests, the change and its effect must first be shown in the chat, you must approve it, and then you must accept the separate macOS approval window.

| Request type | Example supported operations | Example request in Claude Code |
| - | - | - |
| Account and organization | View profile/organizations; local flows for registration, password reset/change, phone verification, organization assignment, and sign-out | `/connexease-gateway-ops:panel-ops Show my connected account profile and the organizations I can access.` |
| Applications | List/details, WhatsApp and Instagram health/profile information; update application name/contact information/WhatsApp username | `/connexease-gateway-ops:panel-ops List my applications and show the connection health of the WhatsApp application I select.` |
| WhatsApp templates | Paginated list and details, template library/filters; create, update content, delete, and upload media using a local file picker | `/connexease-gateway-ops:panel-ops List the approved templates of the application I select, including name and language.` |
| Webhook | Read/update URL and event subscriptions, set a secret header in a local window, delete, or send a **real test request** | `/connexease-gateway-ops:panel-ops Show the webhook URL and subscription status of the application I select; do not make changes.` |
| API keys and security | Masked key/organization-secret metadata, create a key or secret, revoke an application API key, allowed-origin list | `/connexease-gateway-ops:panel-ops Show only the name, status, and expiration date of the API keys for the application I select.` |
| Billing | Wallet balance, billing account, non-sensitive card metadata, invoices, coupon validation; update billing account | `/connexease-gateway-ops:panel-ops Show my wallet balance and latest invoices; do not initiate a payment.` |
| Insight and CSV | A single table/chart or comparison of two periods; export panel-formatted CSV through a local save window | `/connexease-gateway-ops:panel-ops Before saving Messages Breakup data as CSV for September 2026, show which data will be retrieved.` |

**Important limitations:** Creating or updating a template does not cause Meta to approve it. Webhook tests send real external requests. Revoking an API key cannot be undone; the raw value of a newly created key is not displayed in the AI chat and is shown once in a local window. A new WhatsApp/Instagram connection requires Meta Embedded Signup, and payment requires the Stripe flow in the browser/panel. Operations must not be attempted by guessing an unsupported API endpoint.

### `sandbox-ops`: test numbers and messages

**Purpose:** View an application's registered test numbers, add/rename/delete a number, and actually send **supported** text or an approved WhatsApp template in the sandbox.

**Safe sending sequence:** (1) Select the application; (2) view registered numbers and, if necessary, separately add a new number in international **E.164** format; (3) specify the exact message, or the template name/language and required parameters; (4) check the recipient, content, and `not_sent` status in the `prepare` preview; (5) explicitly say “Yes, send it” in the chat **for that preview**; (6) accept the separate macOS send approval. Approval to add a number is not approval to send a message. `not_sent` means that no message was actually sent.

```text theme={null}
/connexease-gateway-ops:sandbox-ops Show my applications and the registered test numbers for the application I select; do not send a message yet.
/connexease-gateway-ops:sandbox-ops I want to add +905321234567 to the application I select as a test number with the label "QA". Ask for approval first.
/connexease-gateway-ops:sandbox-ops Show a complete preview of the text "Hello, this is a test" to the registered test number I select before sending it.
/connexease-gateway-ops:sandbox-ops Show the name, language, and required parameters of the approved template I select; preview it before sending it to the test number.
```

To send a template, it must be approved and contain supported components; product/carousel types are blocked. A successful API response shows that Gateway accepted the request, not that WhatsApp delivered it. After a timeout or ambiguous result, the send is not retried automatically; check its status in Gateway history first. **The `is_fake=true` test in the documentation and the approved real sandbox send described here are different operations.**

### `insights`: tables, charts, and comparisons

**Purpose:** Display the **single** named view from the Insight page as a table and an appropriate Unicode chart in the terminal, or compare the **same view** across two explicit date ranges. Specify the application filter, date, daily/monthly granularity, or metric to plot when needed; otherwise, the Gateway default may be applied. If the name is ambiguous, the assistant should present a list of views and ask you to choose; it should not retrieve adjacent tables automatically.

| Panel name / view | What should you expect? |
| - | - |
| `Messages Breakup` | The requested page of the message distribution table; a comparison loads the full table or returns an error. |
| `Template Breakup` | The template distribution table. |
| `Messages Over Time` | Message trend line and table. |
| `Messages by Category` | Category table and bar chart. |
| `Messaging Cost Over Time` | Cost trend line. |
| `Messaging Count Over Time` | Message-count trend line. |
| `Summary` | Summary metrics. `Apps Overview` is still mocked/Coming Soon in the panel and is not presented as real data. |

```text theme={null}
/connexease-gateway-ops:insights Show only the Messages Breakup table for September 1–30, 2026; do not retrieve another table.
/connexease-gateway-ops:insights Show the Messages Over Time view for September 1–30, 2026 as a daily line chart.
/connexease-gateway-ops:insights Compare September 1–15, 2026 (A) with September 16–30, 2026 (B) for Messaging Cost Over Time, using the same application and daily granularity.
```

For a comparison, the **start and end dates** of both periods must be given explicitly. Change is calculated as `B − A`, and percentage change uses A as the baseline; if A is zero, the percentage is `n/a`. Pay attention to warnings about periods that differ in length or overlap. The terminal chart is not an exact replica of the panel's interactive web chart.

## 3. Troubleshooting

| Symptom | First check |
| - | - |
| `/connexease-gateway-ops:ask` does not appear in Claude | Use `claude plugin list` to confirm that the plugin is enabled, then restart the Claude session. |
| The documentation response cannot provide a source | Check that the client can access the internet and `docs.gateway.connexease.com`. Do not rely on unverified links or fields. |
| Panel tools request sign-in | Start the `connect` flow for the client you are using; enter the password or code in local windows, not in the chat. |
| The operation fails or the API returns `404` | Check the application/account permissions and the environment you are using; the plugin must not guess and try an unsupported endpoint. |
| The Gemini extension/commands do not appear | Reopen the Gemini CLI session; check the extension installation and Gemini CLI sign-in status. The old docs-only skill does not replace the new operations extension. |
| The Claude slash command does not work in Codex | This is expected: use natural language or installed skills in Codex; Claude-specific `/connexease-gateway-ops:...` syntax is not a Codex command. |
| Panel tools do not appear in Codex/Gemini | Confirm that the `connexease-gateway-ops` package or Gemini extension is installed, the client has been restarted, and Node.js 20+ is available. The docs-only package does not include panel tools. |

When requesting support, share the client you used, the plugin version, the steps you took, and the error text **without sensitive information**. Do not send a password, token, API key, or message content.


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