---
title: "add_variant"
description: "Add a new variant (environment slice) to a variable group."
sidebarTitle: "add_variant"
lastUpdated: "2026-09-23"
---

> **For AI agents:** the complete documentation index is at [llms.txt](/llms.txt). Append `.md` to any page URL for its markdown version.

{/* GENERATED FILE: do not edit by hand. Regenerate with: node scripts/generate.mjs */}

Add a new variant (environment slice) to a variable group.

<Info>
  **Writes data · Calls external systems.**
</Info>

## Parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `acknowledge` | boolean | No | Reset edit budget after user approval |
| `group_id` | number | Yes | Variable group id |
| `is_default` | boolean | No | Make this the default variant (demotes the prior default) |
| `name` | string | Yes | Variant name (e.g. "canary") |

## Example arguments

Illustrative arguments an agent supplies when calling this tool:

```json
{
  "group_id": 0,
  "name": "string"
}
```

## Description

```text
If is_default=true the prior default is demoted in the same atomic update. The platform auto-fans new variants into existing variables in the group.
```

## What's next?

<Columns cols={2}>
  <Card title="All MCP tools" icon="robot" href="/mcp/tools/overview">
    Browse the full tool reference by category.
  </Card>
  <Card title="Connect a client" icon="plug" href="/mcp/connect">
    Point Claude, Cursor, or Claude Code at the server.
  </Card>
</Columns>