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

> Add the Rings MCP server to Windsurf Cascade

<Steps>
  <Step title="Open MCP settings">
    Click the **MCP** icon in the top-right of the Cascade panel, or go to
    **Settings → Cascade → MCP Servers**.
  </Step>

  <Step title="Open the raw config">
    Choose **Add custom server** (or **View raw config**) to open
    `~/.codeium/windsurf/mcp_config.json`.
  </Step>

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

    Remote servers use `serverUrl` instead of a `command`.
  </Step>

  <Step title="Refresh and authenticate">
    Save the file and click **Refresh** in the MCP panel. Windsurf connects and
    prompts you to sign in to Rings.
  </Step>

  <Step title="Check the tools">
    The Rings tools appear under the server entry in the MCP panel. Toggle off
    any you do not want Cascade to call.
  </Step>
</Steps>

## Using an API key instead

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

Windsurf interpolates `${env:VAR_NAME}` and `${file:/path/to/file}` in config
values, so the key never has to sit in the file itself.
