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

# Add the Rings connector

> Pick your AI platform and follow the exact UI steps to add the Rings MCP server

Every AI platform below talks to the **same** Rings MCP server. Whatever you are
setting up, you need exactly two things:

<CardGroup cols={2}>
  <Card title="Server URL" icon="server">
    `https://production-api.joinrings.com/mcp`
  </Card>

  <Card title="Your Rings login" icon="key">
    Sign in through the OAuth prompt the client shows you. No client ID or secret to paste.
  </Card>
</CardGroup>

<Note>
  The server supports OAuth 2.0 [Dynamic Client
  Registration](https://datatracker.ietf.org/doc/html/rfc7591) and publishes its
  metadata at `/.well-known/oauth-authorization-server`. Clients discover the
  endpoints themselves, so leave **Client ID** and **Client Secret** blank
  unless a form marks them required.
</Note>

## Pick your platform

<CardGroup cols={2}>
  <Card title="Claude" icon="message" href="/guides/mcp/claude">
    Claude apps, Claude Code, and the Claude API
  </Card>

  <Card title="ChatGPT" icon="comments" href="/guides/mcp/chatgpt">
    ChatGPT developer mode and the OpenAI Responses API
  </Card>

  <Card title="Cursor" icon="code" href="/guides/mcp/cursor">
    Cursor IDE and Cursor Agents
  </Card>

  <Card title="Perplexity" icon="magnifying-glass" href="/guides/mcp/perplexity">
    Perplexity custom remote connectors
  </Card>

  <Card title="VS Code" icon="code-branch" href="/guides/mcp/vscode">
    GitHub Copilot agent mode in VS Code
  </Card>

  <Card title="Windsurf" icon="wind" href="/guides/mcp/windsurf">
    Windsurf Cascade
  </Card>

  <Card title="Gemini CLI" icon="terminal" href="/guides/mcp/gemini">
    Google Gemini CLI
  </Card>

  <Card title="Copilot Studio" icon="robot" href="/guides/mcp/copilot-studio">
    Microsoft Copilot Studio agents
  </Card>

  <Card title="Other clients" icon="ellipsis" href="/guides/mcp/other-clients">
    Zed, Cline, Goose, and any other MCP client
  </Card>
</CardGroup>

## Which auth should I use?

| You are                          | Use         | How                                                                            |
| -------------------------------- | ----------- | ------------------------------------------------------------------------------ |
| A person using a chat app or IDE | **OAuth**   | Click **Connect** or **Sign in** when the client prompts, then approve access. |
| A backend service or automation  | **API key** | Send `x-api-key: <your key>` as a custom header.                               |

Both paths give the client the same permissions the signed-in user already has
in Rings. See the [Quickstart](/quickstart) for how to mint an API key.

<Tip>
  With a **tenant-scoped** API key, also send `x-rings-user-id: <user UUID>` to
  act as a specific user. Tools that need a user identity — meetings, tasks, all
  writes, `/relationships/mine` — return `403` without it.
</Tip>

## Requirements the client must meet

| Requirement   | Value                                                 |
| ------------- | ----------------------------------------------------- |
| Transport     | Streamable HTTP (stateless — no server-side sessions) |
| Scheme        | HTTPS only                                            |
| Auth          | OAuth 2.0, or an `x-api-key` header                   |
| Local `stdio` | Not applicable — Rings is a hosted remote server      |

If a client asks you to choose a transport, pick **Streamable HTTP**, not SSE.

## Verify the connection

Once connected, ask the assistant:

```text theme={null}
List the tools you have from Rings, then look up the company rings.ai.
```

You should see Rings tools listed and a company record come back. If the tool
list is empty, the client connected but never completed OAuth — reconnect and
finish the sign-in prompt.

## Troubleshooting

<AccordionGroup>
  <Accordion title="The client shows 0 tools" icon="circle-xmark">
    Authentication did not complete. Disconnect and re-add the connector, and
    make sure you finish the browser sign-in and land back on the client.
  </Accordion>

  <Accordion title="401 Unauthorized" icon="lock">
    The OAuth token expired or the API key is wrong. Reconnect, or check that
    the key is sent as `x-api-key` and not `Authorization: Bearer`.
  </Accordion>

  <Accordion title="403 Forbidden on meetings, tasks, or writes" icon="user-lock">
    Those tools need a user identity. Use a user-scoped key, or add the
    `x-rings-user-id` header to a tenant-scoped key.
  </Accordion>

  <Accordion title="429 Too Many Requests" icon="gauge-high">
    Per-second and monthly limits apply. Respect `Retry-After` and back off —
    see [rate limiting](/guides/mcp#rate-limiting).
  </Accordion>

  <Accordion title="A record you just created returns 404" icon="clock">
    Reads route to a replica shortly after a write. Use the UUID the write
    returned instead of re-fetching to confirm it worked.
  </Accordion>
</AccordionGroup>
