> ## 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.

# Connect Cursor

> Add the Rings MCP server to Cursor with mcp.json and OAuth

Cursor configures custom MCP servers through an `mcp.json` file. The UI in
**Customize** enables, disables, and authenticates them.

<Steps>
  <Step title="Create mcp.json">
    Pick a scope:

    * **This project** — `.cursor/mcp.json` in the project root
    * **Everywhere** — `~/.cursor/mcp.json` in your home directory

    In Cursor you can also open **Customize** in the sidebar and use the MCP
    section's **New MCP Server** action, which opens the same file for you.
  </Step>

  <Step title="Add the Rings server">
    ```json theme={null}
    {
      "mcpServers": {
        "rings": {
          "url": "https://production-api.joinrings.com/mcp"
        }
      }
    }
    ```
  </Step>

  <Step title="Save and authenticate">
    Save the file. Cursor picks up the server and prompts you to sign in —
    complete the Rings OAuth flow in the browser.
  </Step>

  <Step title="Enable it">
    Open **Customize** in the sidebar, find **rings**, and make sure its toggle
    is on. Its tools now appear under **Available Tools** in chat and Plan Mode.
  </Step>
</Steps>

## Using an API key instead

For a headless or CI setup where OAuth is impractical, send the key as a header
and keep it in an environment variable:

```json theme={null}
{
  "mcpServers": {
    "rings": {
      "url": "https://production-api.joinrings.com/mcp",
      "headers": {
        "x-api-key": "${env:RINGS_API_KEY}"
      }
    }
  }
}
```

Cursor interpolates `${env:NAME}` in `url` and `headers`. Never commit a raw key
to `.cursor/mcp.json`.

## Team rollout

Team admins can distribute Rings to everyone from **Dashboard → Integrations &
MCP**, then select **Add to Team Marketplace** so teammates can install it from
**Customize**. If your organization uses the MCP allowlist
(**Team Settings → MCP Configuration**), add a URL entry for
`https://production-api.joinrings.com/mcp` first.

<Tip>
  Cursor asks for approval before each MCP tool call. Click the arrow next to a
  tool name to inspect the arguments before approving a write.
</Tip>

## Troubleshooting

Open the Output panel (<kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>U</kbd> /
<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>U</kbd>) and select **MCP Logs** to see
connection, authentication, and tool-call errors. Restart Cursor after editing
`mcp.json` if the server does not appear.