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

# Connect Chatarmin MCP to AI tools

> Step-by-step setup for Cursor, Claude, ChatGPT, VS Code, and GitHub Copilot.

Connect Chatarmin MCP to your preferred AI assistant so it can use your organization’s campaigns, contacts, flows, and analytics.

<Note>
  You need a Chatarmin account with access to **Profile → MCP**. OAuth is recommended; see [Chatarmin MCP](/api-documentation/chatarmin-mcp) for capabilities and troubleshooting.
</Note>

**MCP endpoint URL (all clients):**

```
https://api.chatarmin.com/api/mcp
```

**OAuth config (Cursor and other clients that use `mcp.json`):**

```json theme={null}
{
  "mcpServers": {
    "chatarmin": {
      "url": "https://api.chatarmin.com/api/mcp"
    }
  }
}
```

***

## Cursor

Cursor supports remote MCP servers with OAuth. No API token is required in your config.

<Steps>
  <Step title="Copy your OAuth config">
    In Chatarmin, open **Profile → MCP** and click **Copy OAuth config** (or copy the JSON shown on that page).

    <Frame>
      <img src="https://mintcdn.com/chatarmin-help-center/lGe-w4qMajFJnjYi/images/api-documentation/profile-mcp-connect-section.png?fit=max&auto=format&n=lGe-w4qMajFJnjYi&q=85&s=d4d0a6f1d9dd8ff4c3361820c4271a08" alt="Chatarmin MCP endpoint URL and Copy OAuth config buttons" width="1860" height="1040" data-path="images/api-documentation/profile-mcp-connect-section.png" />
    </Frame>
  </Step>

  <Step title="Add the server to Cursor">
    Open **Cursor Settings → Tools & MCP** (or edit `~/.cursor/mcp.json` / `.cursor/mcp.json` in a project).

    Paste the Chatarmin OAuth config under `mcpServers`, or add:

    ```json theme={null}
    {
      "mcpServers": {
        "chatarmin": {
          "url": "https://api.chatarmin.com/api/mcp"
        }
      }
    }
    ```
  </Step>

  <Step title="Connect">
    In **Tools & MCP**, find **chatarmin** and click **Connect**.

    Your browser opens the Chatarmin consent screen. Sign in and click **Allow access**.

    <Frame>
      <img src="https://mintcdn.com/chatarmin-help-center/lGe-w4qMajFJnjYi/images/api-documentation/mcp-oauth-consent.png?fit=max&auto=format&n=lGe-w4qMajFJnjYi&q=85&s=728db6b5c6cc8f00c9b4d6aeccb34ab6" alt="Chatarmin MCP OAuth consent screen for Cursor" width="2880" height="1800" data-path="images/api-documentation/mcp-oauth-consent.png" />
    </Frame>
  </Step>

  <Step title="Use Chatarmin in the agent">
    In Cursor Agent or Chat, ask questions that need live Chatarmin data. Confirm tool calls when Cursor prompts you.
  </Step>
</Steps>

<Tip>
  Project-specific tools: add `.cursor/mcp.json` in your repo. User-wide tools: use `~/.cursor/mcp.json`.
</Tip>

***

## Claude (Desktop and web)

Claude connects to remote MCP servers through **custom connectors**. Anthropic’s cloud reaches your server over HTTPS—use the Chatarmin production URL, not a local address.

<Steps>
  <Step title="Open Connectors">
    In Claude Desktop or [claude.ai](https://claude.ai), open **Settings**.

    * **Personal:** **Customize → Connectors**
    * **Team / Enterprise:** **Organization settings → Connectors**
  </Step>

  <Step title="Add a custom connector">
    Click **Add custom connector** (or **Add → Custom**, type **Web** if asked).

    Enter:

    | Field | Value                               |
    | ----- | ----------------------------------- |
    | Name  | `Chatarmin`                         |
    | URL   | `https://api.chatarmin.com/api/mcp` |

    Leave transport on the detected default (Streamable HTTP) unless Chatarmin support advises otherwise.
  </Step>

  <Step title="Authenticate">
    Choose **OAuth** when prompted. Complete sign-in on the Chatarmin consent screen and click **Allow access**.
  </Step>

  <Step title="Enable in a chat">
    Start a new conversation, open the tools or connectors menu, and enable **Chatarmin**. Ask your question and approve tool use when Claude requests it.
  </Step>
</Steps>

<Note>
  Free plans may limit the number of custom connectors. Remote connectors require a public HTTPS URL—Chatarmin’s hosted endpoint works out of the box.
</Note>

***

## ChatGPT

ChatGPT connects to remote MCP servers as **custom connectors** when **Developer mode** is enabled (paid plans).

<Steps>
  <Step title="Enable Developer mode">
    In ChatGPT (web), open **Settings**.

    Enable **Developer mode** (location varies by rollout—check **Apps → Advanced settings**, **Connectors → Advanced**, or **Security and login**).
  </Step>

  <Step title="Create a connector">
    Go to **Settings → Connectors** (or **Plugins**) and click **Create** / **Add connector**.

    | Field          | Value                               |
    | -------------- | ----------------------------------- |
    | Name           | `Chatarmin`                         |
    | Connector URL  | `https://api.chatarmin.com/api/mcp` |
    | Authentication | OAuth                               |
  </Step>

  <Step title="Sign in to Chatarmin">
    Complete the OAuth flow in your browser. On the Chatarmin consent screen, click **Allow access**.
  </Step>

  <Step title="Use in a chat">
    Start a new chat, enable the **Chatarmin** connector, and ask your question. ChatGPT asks for confirmation before write actions.
  </Step>
</Steps>

<Warning>
  ChatGPT only supports **remote HTTPS** MCP servers. You cannot point it at a local stdio process without hosting or tunneling the server first.
</Warning>

***

## VS Code

VS Code supports MCP through compatible extensions and the MCP ecosystem. Setup depends on your extension; the Chatarmin URL and OAuth flow stay the same.

<Steps>
  <Step title="Install an MCP-capable extension">
    Install an extension that supports **remote HTTP MCP** with OAuth (for example GitHub Copilot’s agent mode or a dedicated MCP extension from the marketplace).

    Follow that extension’s docs for adding a remote server.
  </Step>

  <Step title="Add the Chatarmin server">
    When prompted for a server URL, enter:

    ```
    https://api.chatarmin.com/api/mcp
    ```

    If the extension uses JSON config, use the OAuth block from **Profile → MCP** in Chatarmin.
  </Step>

  <Step title="Connect with OAuth">
    Trigger **Connect** or **Authenticate** in the extension. Complete the Chatarmin consent screen in your browser.
  </Step>
</Steps>

***

## GitHub Copilot

GitHub Copilot (in VS Code, JetBrains, or Copilot Chat) can use MCP servers where your client version supports remote connectors.

<Steps>
  <Step title="Check MCP support">
    Ensure your Copilot client supports MCP connectors (see [GitHub Copilot documentation](https://docs.github.com/en/copilot) for your editor).
  </Step>

  <Step title="Add Chatarmin">
    Add a remote MCP server with URL `https://api.chatarmin.com/api/mcp` and authentication **OAuth**, following your editor’s MCP or Copilot settings UI.
  </Step>

  <Step title="Authorize">
    Run the connect flow and approve access on the Chatarmin OAuth screen.
  </Step>
</Steps>

***

## Bearer token fallback

If a client does not support OAuth, use your API token from **Profile → Settings → API token**:

```json theme={null}
{
  "mcpServers": {
    "chatarmin": {
      "url": "https://api.chatarmin.com/api/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_TOKEN"
      }
    }
  }
}
```

For Claude Desktop legacy `claude_desktop_config.json` setups, you can bridge with `mcp-remote`:

```json theme={null}
{
  "mcpServers": {
    "chatarmin": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://api.chatarmin.com/api/mcp",
        "--header",
        "Authorization: Bearer YOUR_API_TOKEN"
      ]
    }
  }
}
```

## FAQ

**Do I need a separate MCP API key?**\
No. OAuth uses your Chatarmin login. The Bearer fallback reuses your existing **API token**.

**Can I revoke access?**\
Manage connections from **Profile → MCP** in Chatarmin and disconnect or rotate your API token in **Profile → Settings** if you used Bearer auth.

**Which clients are officially supported?**\
Any MCP client that supports remote HTTPS servers and OAuth (or Bearer headers) can connect. The guides above cover the most common tools; steps may shift slightly as each product updates its UI.