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

# Connect an AI assistant

> Connect Claude, ChatGPT, Cursor, VS Code or Claude Code to Heralded by signing in. No key to copy.

An AI assistant connects to Heralded's MCP server by signing in to Heralded, the way you sign in to the app. You pick the workspace it reads, approve it once, and it reads the brands you can read there. Agency plans call it an organization. It cannot change anything.

The server URL is:

```text theme={null}
https://api.heralded.ai/v1/mcp
```

In Heralded, **Use Heralded in your AI assistant** on your workspace's **Connections** settings page has the same steps, with the URL and install links ready to copy. A member with access to a single brand finds it on the brand's **Connections** page.

## Set up your assistant

<Tabs>
  <Tab title="Claude">
    1. In Claude, open **Settings › Connectors** and choose **Add custom connector**.
    2. Name it Heralded, paste the server URL and choose **Add**.
    3. Choose **Connect**, sign in to Heralded and pick the workspace.
  </Tab>

  <Tab title="ChatGPT">
    1. In ChatGPT on the web, open **Settings › Apps › Advanced settings** and turn on **Developer mode**. Your plan and workspace role decide whether it is offered.
    2. In **Apps**, choose **Create app**. Name it Heralded, paste the server URL and pick **OAuth** under **Authentication**.
    3. Tick **I understand and want to continue**, choose **Scan Tools**, sign in to Heralded and pick the workspace, then choose **Create**.
  </Tab>

  <Tab title="Cursor">
    1. On Connections in Heralded, choose **Connect**, then **Cursor** and **Add to Cursor**. Cursor opens its MCP settings with Heralded filled in. Choose **Install**.
    2. Choose **Connect** beside Heralded, sign in and pick the workspace.

    To add it by hand instead, put the server in `~/.cursor/mcp.json`:

    ```json theme={null}
    { "mcpServers": { "heralded": { "url": "https://api.heralded.ai/v1/mcp" } } }
    ```
  </Tab>

  <Tab title="VS Code">
    1. On Connections in Heralded, choose **Connect**, then **VS Code** and **Add to VS Code**. VS Code shows the Heralded server. Choose **Install**.
    2. When VS Code asks, allow it to sign in to Heralded, then pick the workspace.

    To add it by hand instead, put the server in `.vscode/mcp.json`:

    ```json theme={null}
    { "servers": { "heralded": { "type": "http", "url": "https://api.heralded.ai/v1/mcp" } } }
    ```
  </Tab>

  <Tab title="Claude Code">
    1. Run:
       ```bash theme={null}
       claude mcp add --transport http heralded https://api.heralded.ai/v1/mcp
       ```
    2. In Claude Code, run `/mcp`, choose **heralded** and **Authenticate**, then sign in and pick the workspace.
  </Tab>

  <Tab title="Other clients">
    A client that signs in with OAuth needs only the server URL. It finds Heralded's sign-in from the server itself. A client that takes a header instead can use an [API key](/api-keys); [Connect an MCP client](/connect-mcp) has the setup.
  </Tab>
</Tabs>

## What you approve

The consent screen names the assistant and the domain it is published from. When the assistant registered itself rather than being published from a known address, the screen marks it unverified. Check the name before you approve it.

Heralded asks you to sign in again when your session is more than a day old, so a device you left signed in cannot connect an assistant on its own.

The assistant reads as you, in the workspace you picked. It sees the brands you can see, and loses them when you do.

## See and revoke assistants

Each connected assistant is a row under **Use Heralded in your AI assistant**, with who connected it, when, and when it last read. Revoke ends it: its next call fails, and connecting it again needs a new sign-in.

You see and revoke the assistants you connected. An owner or admin sees and revokes every member's.

## Tools

The assistant gets the same read-only tools as a client connected with a key. [Connect an MCP client](/connect-mcp#tools) lists them.


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