> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fluid.app/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract.
> Authenticate with the header Authorization: Bearer <token>; public storefront read endpoints require no auth.
> To sign a new merchant up for Fluid programmatically, run `fluid signup` from the Fluid CLI, or call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token.
> After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch.
> To host a small project on Fluid (a landing page, event page, calculator or dashboard), follow /sites/quickstart: npm create @fluid-app/fluid-site my-site (or npx @fluid-app/create-fluid-site my-site), fluid login, then fluid deploy prints the public URL. Launch a Site unless the project needs a custom domain, server rendering or heavy server code, which make it an App (a Mist app); /sites/site-or-app has the rule, and POST /api/company/v2026-10/project-launch-recommendations applies it. With only the Fluid MCP server (its Site write tools are limited to Fluid root admins today; see /sites/deploy-from-claude), use site_create, then site_deploy (send the built folder's manifest, PUT the listed uploads, call again with the bundle_id to get the url), then, only after the person confirms they want it public, site_visibility_set; the MCP server has no tools for logs, traffic, env vars or converting to an App, so use the fluid sites CLI for those.
> Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null.
> When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors.
> Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile.
> The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country).
> api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract).
> Successful responses wrap the resource payload alongside a top-level integer status and a meta object.
> Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other.
> For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces.
> Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings.
> Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties.
> Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables.
> A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation.
> The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations.
> Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check.
> Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times.

# Build and deploy a Site from Claude with the Fluid MCP

> Use the Fluid MCP server's Site tools from Claude Code or claude.ai: list and read Sites, create a company Site, deploy a built folder in two calls, make it public and roll it back.

The Fluid MCP server, at `https://mcp.fluid.app/mcp`, has tools that read, create, deploy and roll back company Sites. An AI client such as Claude Code builds the Site on your machine, then deploys the build through these tools, with no Fluid CLI.

> [!WARNING]
>
> The Site write tools are for Fluid root admins only today, and they reach the production MCP server in a later release. Everyone else, and anyone who needs logs, traffic, env vars or the source saved in git, deploys with the [Fluid CLI](https://docs.fluid.app/sites/quickstart.md): `fluid deploy`.

## Connect

Add the server to your client and sign in with your Fluid account when it asks. In Claude Code:

```bash theme={null}
claude mcp add --transport http fluid https://mcp.fluid.app/mcp
```

The sign-in screen says what the client may do. To let it use the write tools, tick **Let this app make changes**. The box is off by default. For how agents connect to Fluid, see [Connect AI tools](https://docs.fluid.app/guides/connect-ai-tools.md).

## The tools

| Tool | What it does |
| - | - |
| `sites_list` | Lists a company's Sites. Takes `owner_kind`, `cursor` and `limit` |
| `site_get` | One Site and, for a company Site, its ten latest deployments with their bundle ids |
| `site_create` | Creates a company Site, private and empty. Takes `name` and `handle` |
| `site_deploy` | Uploads a built folder and publishes it, in two calls |
| `site_visibility_set` | Makes a Site `public` or `private` |
| `site_rollback` | Makes an earlier published deployment live again. Takes `site_id` and the deployment's `bundle_id` |

Every tool takes the company's `company_id`. `companies_list` lists the companies you can reach.

### Who can use them

* **Reads** need an admin of the company whose role grants `application_themes.view`, or a Fluid root admin.
* **Writes** need all of these:
  * you're a Fluid root admin, in the pilot that gives root access through MCP;
  * the client is Claude Code or claude.ai;
  * you ticked **Let this app make changes** when you signed in, less than 7 days ago. After 7 days the client asks you to sign in again;
  * `application_themes.update` in the company. Root admins hold it.

Every tool needs Sites turned on for the company. Without them, a call answers `sites_not_enabled`. A client that may not use the write tools doesn't see them in its tool list.

Each write is logged with who made it, the client and the Site.

## Create a Site

`site_create` makes a company Site that's private and has nothing published. Always pass a `handle`: lowercase letters, digits and single hyphens, at most 40 characters. If the call times out, it may still have made the Site. Calling again with the same handle answers that the handle is taken, where a call with no handle would make a second Site.

The tools only create company Sites. A member's own Site is made with `fluid sites create`.

## Deploy a built folder

The client builds the Site first, such as with `npm run build`, then deploys the build folder in two calls.

**1. Send the manifest.** Call `site_deploy` with `site_id` and `files`: each file's path in the build, such as `/index.html`, mapped to its `sha256` (hex), `size` in bytes and `contentType`. You can also send `routes`, and the Site's `schema`, `access` and `meta`: the contents of `db/schema.json`, `config/access.json` and `config/meta.json`.

```json theme={null}
{
  "company_id": "0192…",
  "site_id": "0193…",
  "files": {
    "/index.html": { "sha256": "9f2c…", "size": 812, "contentType": "text/html" },
    "/assets/index-4f1a.js": { "sha256": "b71e…", "size": 48211, "contentType": "text/javascript" }
  },
  "meta": { "default": { "title": "Spring launch" } }
}
```

The answer has a `bundle_id` and `uploads`.

**2. Upload the files.** `PUT` each file listed in `uploads` to its URL, with exactly the headers it lists. Files Fluid already stores aren't listed.

**3. Publish.** Call `site_deploy` again with the same `site_id` and the `bundle_id`, and no `files`. The answer has the Site's live `url`. Publishing replaces what's live.

Limits:

* At most 500 files a deploy, each up to 25 MiB. Deploy a larger build with `fluid deploy`.
* An upload URL expires after 60 minutes. After that, start again from the first call.
* A file the checks refuse comes back as `refused`, with a `code`, a `message` and the file's `path`. Fix it and start again.

### Schema changes that delete data

When the Site's `schema` drops or rewrites a table or column, the publish call comes back `refused` with the code `destructive_change_unconfirmed`. It lists each migration id and, in words, what it would lose. Nothing is published. Show that to the person, and only after they say yes, call again with `confirm_migrations` set to those ids. See [Change the schema](https://docs.fluid.app/sites/database.md#change-the-schema).

### What the client needs

The MCP tools don't build anything or move file bytes. The client needs a shell, or another way to run the build, hash each file and send `PUT` requests to the upload URLs. Claude Code can. A chat client with no way to run commands or make HTTP requests can create a Site and change its visibility, but can't deploy one.

A deploy through MCP doesn't save the Site's source in git. `fluid deploy` and `fluid sites publish` do. See [Source and branches](https://docs.fluid.app/sites/source-and-branches.md).

## Make it public

`site_visibility_set` with `public` lets anyone with the address open the Site. `private` leaves it to company admins and the members its shares admit. A new Site is private. See [Who can open a Site](https://docs.fluid.app/sites/overview.md#who-can-open-a-site).

## Roll back

Call `site_get` to list the latest deployments, then `site_rollback` with the `bundle_id` of the one to bring back. It's live at once, with no upload.

## Plain HTML

A Site doesn't need a framework. A published Site serves the Sites SDK at `/_fluid/sdk/v1/sites.js`, so a page with no build step can import it:

```html theme={null}
<script type="module">
  import { fluid } from "/_fluid/sdk/v1/sites.js";
  const viewer = await fluid.auth.me();
</script>
```

See [Plain HTML](https://docs.fluid.app/sites/frameworks/html.md).

## Example in Claude Code

After connecting the server, ask in a project folder:

```text theme={null}
Build a one-page Vite and React Site for our spring launch: a hero, three product
cards and a sign-up button. Create it as a company Site in Yoli with the handle
spring-launch, deploy the build, and give me the URL. Keep it private.
```

Claude Code scaffolds and builds the project, calls `site_create`, hashes the files in `dist/`, calls `site_deploy` with the manifest, uploads the listed files, and calls `site_deploy` again to publish. It answers with the Site's address. To make it public, ask it to, and it calls `site_visibility_set`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.