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

# Claude Code Guide

This guide covers installation, commands, example responses, security, and update steps for using the Connexease Gateway Customer MCP with Claude Code 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**, Claude Code, **Node.js 20+**, npm, internet access, and your own Connexease Gateway account for panel operations. You do not need to sign in to a Gateway account for documentation-only questions.

Run the following commands in order from any directory in Terminal:

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

| Terminal command | What does it do? |
| - | - |
| `claude plugin marketplace add connexease/connexease-gateway-customer-mcp` | Adds the Connexease plugin catalog on GitHub to Claude Code; it does not install the plugin by itself. |
| `claude plugin install connexease-gateway-ops@connexease-gateway-customer-mcp` | Installs the **single** Claude plugin containing the documentation assistant and panel tools. |
| `claude plugin list` | Checks whether the installation appears as enabled. The list should contain `connexease-gateway-ops@connexease-gateway-customer-mcp`. |
| `claude` | Opens an interactive Claude Code session. Enter subsequent `/...` commands **inside the Claude session, not in the terminal shell**. |

After installing the plugin, you do not need to use `cd` to enter the plugin's cache directory. If a Claude session is already open, restart it so the new plugin can load.

### Commands inside a Claude session

| Command | What does it do? | Is sign-in required? |
| - | - | - |
| `/connexease-gateway-ops:ask <question>` | Researches a topic in the official Gateway documentation and explains it with a link to the verified page. It does not read or change the account. \[Details]\(Connexease Gateway - Introduction.md#ask-asking-documentation-questions). | No |
| `/connexease-gateway-ops:connect` | Signs in to the Gateway account you choose through local macOS windows and displays that account's applications. \[Details]\(Connexease Gateway - Introduction.md#connect-connecting-to-an-account). | This command is the sign-in flow |
| `/connexease-gateway-ops:panel-ops <request>` | Routes supported profile, application, template, webhook, API key, billing, and security operations. Changes require approval. \[Details]\(Connexease Gateway - Introduction.md#panel-ops-panel-operations). | Yes, for account-specific operations |
| `/connexease-gateway-ops:sandbox-ops <request>` | Manages test numbers; previews text or a supported approved template first, then actually sends it only with separate approval. \[Details]\(Connexease Gateway - Introduction.md#sandbox-ops-test-numbers-and-messages). | Yes |
| `/connexease-gateway-ops:insights <request>` | Retrieves the **single** Insight table/chart you name and can compare two explicit date ranges. \[Details]\(Connexease Gateway - Introduction.md#insights-tables-charts-and-comparisons). | Yes |

Examples — enter these **inside the Claude session**:

```text theme={null}
/connexease-gateway-ops:ask How can I test an API request in Sandbox without sending a real WhatsApp message? Include the official documentation link.
/connexease-gateway-ops:connect
/connexease-gateway-ops:panel-ops Which applications are available in this account? Show the webhook status of the application I select.
/connexease-gateway-ops:sandbox-ops Show this application's test numbers; preview a "Hello" message to the number I select before sending it.
/connexease-gateway-ops:insights Retrieve the Messages Breakup table only for September 1–30, 2026.
/connexease-gateway-ops:insights Compare September 1–15 with September 16–30, 2026 in the Messages Over Time chart.
```

### Claude Code: command → example response

The following conversation is an illustrative flow that could occur **in a Claude session** after the plugin is installed. The `connect` response can appear only if the local sign-in windows are completed successfully; other account-dependent responses require the relevant API call to 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.
```

You can also make requests in natural language without using a command, such as “According to the Gateway documentation...” or “Show the applications in my Gateway account.” The commands above are clearer when you want to select a specific workflow explicitly.

`<question>` and `<request>` are placeholders; do not type the angle brackets. For example, enter `/connexease-gateway-ops:panel-ops Show this application's webhook status`. If the application, date, or exact message to send is missing, the assistant should ask for it. You can use `/exit` to leave the Claude session.

### What can be done in the panel?

View the connected account's profile and applications; inspect WhatsApp/Instagram connection health; list, create, and update templates; run webhook and sandbox tests; manage test numbers; perform eligible API key operations; view wallet/billing information; display Insight tables and terminal charts; compare date ranges; and export CSV files. See the repository's [capability matrix](https://github.com/connexease/connexease-gateway-customer-mcp/blob/master/CAPABILITY_MATRIX.md) for detailed and current coverage.

**Limitations:** New WhatsApp/Instagram connections through Meta Embedded Signup and Stripe payment steps still require the browser-based panel flow. Some product/carousel template sends are unsupported. The plugin does not automate every panel screen one for one.

### Security and approval

* Do **not enter** your email/password, verification code, API key, or payment information in a chat message. Sign-in and sensitive fields are handled in local macOS windows.
* When a change or a real sandbox send is requested, the assistant first shows the intended operation and asks for approval in the chat; the tool also opens a second approval on macOS. A preview alone does not send anything.
* Acceptance of a sandbox API request does not prove that the WhatsApp message was delivered to the recipient. After a timeout or ambiguous result, do not automatically repeat the same send; check its status in the panel first.
* If the session key cannot be saved to Keychain, the plugin reports this; sign-in may remain valid only while that client's session is open.

### Updating the Claude plugin

When a new version is released, run the following in Terminal:

```bash theme={null}
claude plugin marketplace update connexease-gateway-customer-mcp
claude plugin update connexease-gateway-ops@connexease-gateway-customer-mcp
claude plugin list
```

Then restart Claude Code. If you previously installed the separate `connexease-gateway-docs` plugin, you can continue to use it; the new `connexease-gateway-ops` installation already includes the `/connexease-gateway-ops:ask` command. The old installation is not removed automatically.


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