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

# Connect your AI

> Add your copy of OpenEmail to Claude, ChatGPT, Codex, Cursor or another MCP client, and allow it in the Shopify admin.

> [!NOTE]
>
> OpenEmail is in early access, so talk to us to install it.

Your AI reaches your copy of OpenEmail over MCP and signs in with OAuth. There's no API key to create or paste: a staff member allows each connection in the Shopify admin, and anyone on your team can revoke it later.

**1. Copy your MCP address**

* In the OpenEmail app in your Shopify admin, open **Settings > Agents**.
* Under **Connect an agent**, the **MCP address** is your hostname followed by `/mcp`, for example `https://email.yourstore.com/mcp`. Click **Copy address**.
* Pick your client in **Which agent do you use?**. The page shows that client's button or command with your address already filled in.

> [!TIP]
>
> **Checkpoint:** you have your MCP address, and the page shows the steps for your client.

**2. Add it to your AI**

If your client already has a server or connector for this address, reuse it instead of adding a second one.

> [tab] Claude
>
> For claude.ai and the Claude desktop app, which share the same connectors.
>
> * On **Settings > Agents**, choose **Claude (web and desktop)** and click **Open Claude**. Claude's custom connector form opens with the name **OpenSubs Email** and your address filled in.
> * Click **Continue**, **Add**, then **Connect**.
> * Or add a custom connector yourself in Claude's connector settings and paste your MCP address as its URL.

> [tab] Claude Code
>
> Run this in your terminal. It adds the server for every project and opens sign-in.
>
> ```bash theme={"dark"}
> claude mcp add --transport http opensubs-email https://email.yourstore.com/mcp --scope user
> claude mcp login opensubs-email
> ```
>
> * Keep the name `opensubs-email`. It's the name the app's commands and setup use.
> * If the browser doesn't open, open the sign-in link Claude Code prints.

> [tab] ChatGPT
>
> > [!WARNING]
> >
> > **ChatGPT's support depends on its connector settings, which change often.** Not every plan can add a custom connector, and on a Business or Enterprise plan an owner or admin may need to add it. Check your workspace's settings before you start.
>
> * On **Settings > Agents**, choose **ChatGPT on the web** and click **Copy address and open ChatGPT**.
> * In ChatGPT's **Plugins**, choose **Add**, then **Add custom MCP server**.
> * Name it **OpenSubs Email** and paste the copied address into the URL field.
> * Select **I understand and want to continue**, then **Create as a plugin** and **Connect**.

> [tab] Codex
>
> Run this in your terminal. In the app, this choice is **Codex or the ChatGPT desktop app**.
>
> ```bash theme={"dark"}
> codex mcp add opensubs-email --url https://email.yourstore.com/mcp
> ```
>
> * Codex starts sign-in. Open its sign-in link if the browser doesn't open.
> * If sign-in didn't start, run `codex mcp login opensubs-email`.

> [tab] Cursor
>
> * On **Settings > Agents**, choose **Cursor** and click **Open in Cursor**. Cursor opens with the server filled in.
> * Open **Cursor Settings > Tools & MCP**, enable `opensubs-email` and choose **Connect**.

> [tab] Other MCP clients
>
> Any client that supports remote MCP servers with OAuth sign-in can connect.
>
> * In your client's MCP settings, add a remote server of type **HTTP**.
> * Use your MCP address as the server URL and `opensubs-email` as its name.
> * Leave any API key or token field empty. The client signs in when it connects.
> * **VS Code:** on **Settings > Agents**, choose **VS Code** and click **Open in VS Code**, then choose **Install**, then **Start**, and sign in when asked.

> [!TIP]
>
> **Checkpoint:** your client opens a browser window to sign in.

**3. Allow it in the Shopify admin**

Every client ends on the **Connect an agent** screen in your Shopify admin. Sign in to Shopify if it asks. Check each part before you decide:

* **The agent:** its name and domain. **Verified** means OpenEmail read the name from a document published on that domain. **Not verified** means the agent supplied its own name, and nobody checked it.
* **Where your browser goes back to:** the address you return to after deciding. Continue only if you expect it.
* **Access:** reading data is always included. **Allow changes to data** lets the agent make changes too. Clear it to allow read access only.
* **Your decision:** who you're signed in as. Activity records your name with whatever you decide.

Click **Allow**. Your browser goes back to the client by itself. If it doesn't, click **Return to agent**.

> [!TIP]
>
> **Checkpoint:** the screen says **Access allowed**, and your client shows the server as connected.

**4. Check it works**

* In a new chat, ask your agent: "Call get\_status and tell me what you see."
* It should answer with your install state, any holds on sending, and any warnings.

> [!TIP]
>
> **Checkpoint:** your agent lists OpenEmail's tools and `get_status` answers. Adding the address alone isn't a connection; this answer is.

> [!NOTE]
>
> The connection request is open for 10 minutes. If it expires, or the screen says it was already answered, ask your agent to connect again.

## Read or read and write

Each connection has one of two levels of access, chosen on the Connect screen.

| Access | What the agent can do |
| - | - |
| **Read only** | Look up contacts, lists, emails, campaigns, flows, status and Activity. It can't change anything. |
| **Read and write** | Everything above, plus draft emails, build campaigns and flows, edit lists and ask for approvals. |

Write access never includes approving. Anything that needs a staff member's yes still needs it, in the Shopify admin. See [What stays with you](https://openemail-docs.mintlify.site/ai/what-stays-with-you.md).

To change a connection's access, connect it again and decide again on the Connect screen. A read-only agent that calls a write tool is refused.

## Revoke access

* Open **Settings > Agents**. The **Connected agents** list shows each connection, who allowed it and when, its access, and when it was last used. Ended connections stay on the list.
* Click **Revoke** beside a connection and confirm with **Revoke connection**.
* To end every connection at once, click **Revoke all** and confirm with **Revoke all connections**.

The next call from a revoked agent is refused. To use it again, connect it and allow it again.

![Settings > Agents: the MCP address with Copy address, the agent picker, and the Connected agents table with Revoke buttons.](https://mintcdn.com/openemail-docs/OnJRIGCNyk9zxe6d/images/setup/settings-agents.png?fit=max\&auto=format\&n=OnJRIGCNyk9zxe6d\&q=85\&s=18607de3b9a154f5c1346dbb6565cf3c)

> [!WARNING]
>
> **Removing a staff member from Shopify doesn't end the connections they allowed.** Those keep working until someone revokes them on **Settings > Agents**. A connection also ends on its own after 90 days without use.

> [card] [What your agent can do](https://openemail-docs.mintlify.site/ai/what-your-agent-can-do.md)
>
> Every tool, grouped by job, and which need write access.

> [card] [Prompts that work](https://openemail-docs.mintlify.site/ai/prompts-that-work.md)
>
> Copy-paste prompts for the daily check, campaigns, flows and more.


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