# Setup actions

> Setup: 4 Xholic actions (1 read, 3 change), each with its MCP tool, REST endpoint and CLI command.

Source: https://docs.xholic.ai/actions/setup/

4 actions. Every field marked *Required* must be sent; `account`, `dryRun`, `idempotencyKey`, `confirmCredits` and `quoteId` are the [control fields](/api/responses/#control-fields) every surface adds.

## Setup status

`setup.status` · read

Where the account is in Xholic's setup (goal, about you, products, finish). Setup can be finished from here with set_goal, setup_about_you, context.add_product (through run_write_action) and finish_setup.

- **MCP tool:** `get_setup`. Catalog: reach it with `find_actions` and `run_read_action`, or turn on the full toolset.
- **REST:** `GET /v1/setup/status`
- **CLI:** `xholic setup status`
- **Scope:** `read`
- **Plan:** Every plan, including the trial
- **Cost:** Free.
- **Rate limit bucket:** `read`

**Input**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `account` | string ≤ 64 chars | No | X account to act on, as @handle. Leave it out to use the connection's default account. |
| `note` | string ≤ 20000 chars | No | Optional, on any tool: one or two sentences for Xholic's shared memory about what the user just decided, asked for or said about themselves or their plans (e.g. "Dropping threads for now; focusing on replies to founders"). Every AI the user connects reads it, so they never repeat themselves. In your words, never other people's posts. Leave it out when nothing new was said. |

## Set the setup goal

`setup.set_goal` · write

Setup step 1: what the user wants from X, as goal ids and/or a short note.

- **MCP tool:** `set_goal`. Catalog: reach it with `find_actions` and `run_write_action`, or turn on the full toolset.
- **REST:** `POST /v1/setup/set-goal`
- **CLI:** `xholic setup set-goal`
- **Scope:** `write`
- **Plan:** Every plan, including the trial
- **Cost:** Free.
- **Rate limit bucket:** `write`

**Input**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `goals` | array of "grow_audience" \\| "find_customers" \\| "promote_product" \\| "personal_brand" \\| "share_learning" \\| "network" (max 6) | Yes |  |
| `note` | string ≤ 120 chars | No | Default: `""`. |
| `account` | string ≤ 64 chars | No | X account to act on, as @handle. Leave it out to use the connection's default account. |
| `dryRun` | boolean | No | Return exactly what would happen without doing it. |
| `idempotencyKey` | string ≤ 200 chars | No | A unique key for this write. Repeating a call with the same key returns the first result instead of acting twice. |

## Tell Xholic about the user

`setup.about_you` · write

Setup step 2: a few sentences about who the user is, what they do and post about (40-500 characters), in their words.

- **MCP tool:** `setup_about_you`. Catalog: reach it with `find_actions` and `run_write_action`, or turn on the full toolset.
- **REST:** `POST /v1/setup/about-you`
- **CLI:** `xholic setup about-you`
- **Scope:** `write`
- **Plan:** Every plan, including the trial
- **Cost:** Free.
- **Rate limit bucket:** `write`

**Input**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `freeText` | string ≤ 500 chars | Yes |  |
| `topicsSelected` | array of "Startups" \\| "Venture Capital" \\| "Marketing" \\| "Sales" \\| "Leadership" \\| "Entrepreneurship" \\| "AI & ML" \\| "Web3" \\| "SaaS" \\| "Cybersecurity" \\| "DevOps" \\| "Mobile" \\| "Design" \\| "Writing" \\| "Photography" \\| "Music" \\| "Film" \\| "Art" \\| "Fitness" \\| "Travel" \\| "Food" \\| "Fashion" \\| "Wellness" \\| "Mindfulness" \\| "Physics" \\| "Biology" \\| "Space" \\| "Climate" \\| "Medicine" \\| "Psychology" \\| "Investing" \\| "Crypto" \\| "Stocks" \\| "Real Estate" \\| "Personal Finance" \\| "Economics" \\| "Trading" (max 6) | No | Topics the user picked, as the onboarding chips offer them. |
| `tonesSelected` | array of "Practical" \\| "Contrarian" \\| "Data-driven" \\| "Story-based" \\| "Short & punchy" | No | Tones the user picked. |
| `account` | string ≤ 64 chars | No | X account to act on, as @handle. Leave it out to use the connection's default account. |
| `note` | string ≤ 20000 chars | No | Optional, on any tool: one or two sentences for Xholic's shared memory about what the user just decided, asked for or said about themselves or their plans (e.g. "Dropping threads for now; focusing on replies to founders"). Every AI the user connects reads it, so they never repeat themselves. In your words, never other people's posts. Leave it out when nothing new was said. |
| `dryRun` | boolean | No | Return exactly what would happen without doing it. |
| `idempotencyKey` | string ≤ 200 chars | No | A unique key for this write. Repeating a call with the same key returns the first result instead of acting twice. |

## Finish setup

`setup.finish` · write

Last setup step, after the goal, about you and products: finishes setup in the user's timezone.

- **MCP tool:** `finish_setup`. Catalog: reach it with `find_actions` and `run_write_action`, or turn on the full toolset.
- **REST:** `POST /v1/setup/finish`
- **CLI:** `xholic setup finish`
- **Scope:** `write`
- **Plan:** Every plan, including the trial
- **Cost:** Free.
- **Rate limit bucket:** `write`

**Input**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `timezone` | string ≤ 100 chars | Yes | IANA timezone, e.g. Asia/Kolkata. |
| `account` | string ≤ 64 chars | No | X account to act on, as @handle. Leave it out to use the connection's default account. |
| `note` | string ≤ 20000 chars | No | Optional, on any tool: one or two sentences for Xholic's shared memory about what the user just decided, asked for or said about themselves or their plans (e.g. "Dropping threads for now; focusing on replies to founders"). Every AI the user connects reads it, so they never repeat themselves. In your words, never other people's posts. Leave it out when nothing new was said. |
| `dryRun` | boolean | No | Return exactly what would happen without doing it. |
| `idempotencyKey` | string ≤ 200 chars | No | A unique key for this write. Repeating a call with the same key returns the first result instead of acting twice. |
