> ## 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 VS Code

> Add the Rings MCP server to GitHub Copilot agent mode in VS Code

<Steps>
  <Step title="Run the add-server command">
    Open the Command Palette (<kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> /
    <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>) and run **MCP: Add Server**.
  </Step>

  <Step title="Choose the config location">
    Pick **Global** to make Rings available in every workspace, or **Workspace**
    to write the entry to `.vscode/mcp.json` in the current project.
  </Step>

  <Step title="Add the server entry">
    ```json theme={null}
    {
      "servers": {
        "rings": {
          "type": "http",
          "url": "https://production-api.joinrings.com/mcp"
        }
      }
    }
    ```
  </Step>

  <Step title="Start it and trust it">
    Save the file and click **Start** above the server entry. Confirm the trust
    prompt, then complete the Rings sign-in in the browser.
  </Step>

  <Step title="Use it in agent mode">
    Open the Chat view, switch to **Agent** mode, and click **Configure Tools**
    to confirm the Rings tools are selected.
  </Step>
</Steps>

## Using an API key instead

Prompt for the key at startup rather than committing it — VS Code stores the
answer securely and reuses it:

```json theme={null}
{
  "inputs": [
    {
      "id": "rings-api-key",
      "type": "promptString",
      "description": "Rings API key",
      "password": true
    }
  ],
  "servers": {
    "rings": {
      "type": "http",
      "url": "https://production-api.joinrings.com/mcp",
      "headers": {
        "x-api-key": "${input:rings-api-key}"
      }
    }
  }
}
```

<Warning>
  Do not hardcode an API key in `.vscode/mcp.json` — that file is usually
  committed to the repository.
</Warning>

## Notes

* Run **MCP: Open User Configuration** to edit the global server list, and
  **MCP: List Servers** to check status, restart, or view logs.
* Copilot agent mode has a tool budget per request. If you connect several MCP
  servers, use **Configure Tools** to keep only the Rings tools you need.