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

# Connect Cursor to ChatSyncs

> Step-by-step: add ChatSyncs to the Cursor editor by putting a chatsyncs entry in ~/.cursor/mcp.json (mcpServers with url https://mcp.chatsyncs.com/mcp), signing in from Cursor's Customize panel by pasting your API key on the ChatSyncs page, the API-key header alternative, and how to switch it off or remove it. Includes the fix for a redirect_uri error on older Cursor versions. Use when a customer asks how to connect Cursor to ChatSyncs or Cursor's ChatSyncs sign-in fails.

Use ChatSyncs from Cursor's Agent while you work.

## Before you start

* **The Cursor desktop app**, updated to the latest version (**Cursor → Check for Updates**).
* **Your ChatSyncs API key**, from the
  [API Developer Console](https://platform.chatsyncs.com/api/developer/console).
  [How to find it](/mcp/api-key).

## Connect

<Steps>
  <Step title="Check whether you already have the settings file">
    Cursor keeps its MCP servers in a file called `mcp.json`, inside a hidden `.cursor` folder in
    your home folder. In Cursor, choose **File → Open File…** and type the path straight into the
    dialog:

    * **Mac:** press **Cmd + Shift + G**, type `~/.cursor/mcp.json`, and press Enter.
    * **Windows:** in the **File name** box, type `%USERPROFILE%\.cursor\mcp.json` and press Enter.

    If the file opens, go to step 3. If it says the file doesn't exist, do step 2.
  </Step>

  <Step title="No file yet? Create it">
    Choose **File → New Text File**, paste this, then **File → Save As…** and save it to the same
    path as in step 1 (`~/.cursor/mcp.json` on Mac, `%USERPROFILE%\.cursor\mcp.json` on Windows):

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

    Then skip to step 4.
  </Step>

  <Step title="Already have a file? Add ChatSyncs to it">
    Inside `"mcpServers": { … }` there is one entry per server. Add the ChatSyncs entry after the
    last one, with a comma after the entry before it. For example, a file that already had a
    server called `github` ends up like this:

    ```json theme={null}
    {
      "mcpServers": {
        "github": {
          "url": "https://api.githubcopilot.com/mcp"
        },
        "chatsyncs": {
          "url": "https://mcp.chatsyncs.com/mcp"
        }
      }
    }
    ```

    Save the file.
  </Step>

  <Step title="Sign in">
    Open **Customize** in Cursor's sidebar and find **chatsyncs** in the MCP section. It shows
    that it needs you to sign in: click its sign-in (**Connect**) button. The label can differ
    between Cursor versions. The ChatSyncs connect page opens in your browser, naming *Cursor* as
    the app. Paste your API key and click **Authorize**.
  </Step>

  <Step title="Confirm">
    Back in Cursor, **chatsyncs** shows as switched on with its tools listed.
  </Step>
</Steps>

## Check it worked

Open the Agent chat and ask:

> **"List my WhatsApp templates."**

Cursor shows the ChatSyncs tool it wants to run and asks for your approval, then lists your
templates.

## Disconnect

* **Pause it:** open **Customize**, find **chatsyncs**, and switch its toggle off.
* **Remove it:** uninstall it from **Customize**, or delete the `"chatsyncs"` entry from
  `~/.cursor/mcp.json`.

To cut off every app that has your key, [regenerate it](/mcp/api-key#revoke-access-regenerate-the-key).

## Frequently asked

<AccordionGroup>
  <Accordion title="Can I use my key instead of the browser sign-in?">
    Yes. Add a `headers` line, replacing `YOUR_CHATSYNCS_API_KEY` with your key:

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

    The key is then stored in plain text in that file. Don't share the file or commit it to git.
  </Accordion>

  <Accordion title="Can I add it to just one project?">
    Yes. Put the same content in `.cursor/mcp.json` inside that project's folder instead. If the
    project is shared through git, use browser sign-in there, never the `headers` version.
  </Accordion>

  <Accordion title="Will Cursor run ChatSyncs actions without asking?">
    By default Cursor asks before each MCP tool runs. If you've set Cursor to auto-run tools,
    remember that ChatSyncs tools send real WhatsApp messages.
  </Accordion>
</AccordionGroup>

## Gotchas

<Warning>
  * **Sign-in fails with an error mentioning `redirect_uri`.** Older Cursor versions use a
    `cursor://` sign-in address that ChatSyncs doesn't accept. Update Cursor, or use the
    `headers` version in the FAQ above.
  * **ChatSyncs doesn't appear after saving.** The file has a typing mistake, often a missing
    comma or bracket. Compare it with the examples above, save it again, and reopen **Customize**.
    Also check it was saved as `mcp.json`, not `mcp.json.txt`.
  * **It appears but the Agent never uses it.** Check the toggle is on, then ask with its name:
    *"Use ChatSyncs to…"*.
</Warning>


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