What is the UI SDK, and how do you use it? Vercel and shadcn's behavior library for agents, installed and tested in Claude Code / Codex / Cursor (0.1.0-beta.1)

The UI SDK is Vercel's behavior library for agents, released on 12 November 2026 as 0.1.0-beta.1. Behaviors live in the framework-free @ui-sdk/core package and are rendered by adapters for React, Vue, Svelte, Solid, and Web Components. This guide follows the official docs on what it is, how to install it, and how to add the skill for Claude Code, Codex, and Cursor, and it records the commands, timings, and output from our test machine.

11 分钟阅读
What is the UI SDK, and how do you use it? Vercel and shadcn's behavior library for agents, installed and tested in Claude Code / Codex / Cursor (0.1.0-beta.1)

The UI SDK is a library of behaviors for coding agents. According to the official repository README and the docs, keyboard navigation, focus, selection, dismissal, popups, drag and drop, and the ARIA those interactions need all live in the framework-free TypeScript core package @ui-sdk/core. Adapters then render them in @ui-sdk/react, @ui-sdk/vue, @ui-sdk/svelte, @ui-sdk/solid, and @ui-sdk/web. It is not a model API, and it does not decide how things look: both the shipped components and the parts you compose with definePrimitive are unstyled, with no provider and no portal.

@vercel announced it on 12 November 2026 at 18:41 UTC (02:41 on 13 November, Asia/Shanghai) with the post "Introducing the UI SDK." In the same window, @shadcn explained the design, and @rauchg compared it to "the x86 instruction set for agents." The docs live at ui-sdk.dev, and the source is vercel-labs/ui. On npm, @ui-sdk/core, @ui-sdk/react, and the other framework packages currently publish 0.1.0-beta.1 under the Apache-2.0 license.

On 13 November 2026 (Asia/Shanghai, UTC+8), we ran the SDK on a Debian 13 x86_64 machine with Node.js v24.22.2, npm 11.19.1, and React 19.3.1. npm install @ui-sdk/react @ui-sdk/core resolved to 0.1.0-beta.1. We copied the official README search-field example into a minimal Vite + React app, and npm run build (tsc -b && vite build) succeeded. We then ran npx skills add vercel-labs/ui --skill ui-sdk and asked Claude Code 2.1.319 and Codex CLI 0.167.0, through this site's API and the skill, to each generate a five-star rating. We did not run a Cursor agent task this time. The versions, commands, timings, and output below come from that run.

Create API Key →

The short version

QuestionAnswer
What is the UI SDK?A behavior library for agents: interactions and ARIA live in @ui-sdk/core, and framework adapters render them.
Current versionnpm 0.1.0-beta.1 (released 12 November 2026, Apache-2.0). The React adapter's peer dependency is React 19+.
How do you install it?For React: npm install @ui-sdk/react @ui-sdk/core. For other frameworks, swap @ui-sdk/react for the matching package.
How do you give it to an agent?Run npx skills add vercel-labs/ui --skill ui-sdk, and update AGENTS.md as the docs describe, pointing at the packaged docs such as node_modules/@ui-sdk/react/docs/llms.txt.
How do you build your own component?Compose behaviors with definePrimitive, then render them with createParts in your framework. Official walkthroughs include the search-field, a mute button, and a reactions bar.
What about shipped components?@ui-sdk/react also ships ready-made components such as Select, Dialog, Tabs, and Rating. They are unstyled and need no provider or portal.
What we ranInstall took about 0.8s. The official search-field build succeeded in about 0.9s. Adding the skill took about 6.7s. Claude Code generated a rating in about 65s and Codex in about 71s; both builds succeeded, and Codex's 2 tests passed.
What to watchThis is a beta, and it is subject to Vercel's public beta terms. The official docs say APIs may still change.

What the UI SDK is

According to the official docs and the README, the UI SDK is not another styled component library. It writes "how an interface behaves" as composable behaviors, then lets you or an agent assemble components from them. The same primitive can render in React, Vue, Svelte, Solid, and Web Components.

According to @shadcn, agents are becoming both the builders and the users of interfaces, so the abstraction should live at the behavior layer. A Select, for example, has a popup, selection logic, keyboard navigation, and focus management — pieces that show up in many other components. Those pieces were pulled apart, tested, and made reusable, and the behavior stays the same whichever framework, renderer, or harness you use. The goal, he wrote, is to give agents the pieces to generate the interface you need, including interfaces "we haven't thought of yet."

According to @rauchg, the UI SDK is "like the x86 instruction set for agents" to build new UI components spontaneously.

The official docs offer two parallel paths:

  • Compose behaviors yourself: define parts, state, and actions with definePrimitive, then render them with createParts. The repository walkthrough is a search-field; the docs also include a mute button and the reactions bar in Build a Component.
  • Use shipped components: @ui-sdk/react exports each component from its own entry, such as @ui-sdk/react/button, @ui-sdk/react/dialog, @ui-sdk/react/tabs, and @ui-sdk/react/rating. The docs state there is no root import from @ui-sdk/react. Components are unstyled, with no dependencies, no provider, and no portal; you add CSS or Tailwind yourself.

To let an agent operate a page that is already rendered, you can call createAgent() to read component state and invoke actions. That API is documented under Agents. The official Agents docs also include a project-settings benchmark (median of three runs per approach, both using Sonnet through Claude Code, every run completed): browser tools took 16 tool calls and 41 seconds; the ui-sdk agent bridge took 5 tool calls and 16 seconds. Those figures come from the official experiment, not from a rerun on our machine.

The UI SDK is in beta. The docs site says: "UI SDK is in beta, so some APIs may still change." Use is subject to the Vercel Public Beta Agreement. Before general availability, APIs, docs, and behaviors may still change.

Launch timing and discussion

The official launch time is the @vercel announcement: 2026-11-12 18:41:04 UTC, which is 2026-11-13 02:41:04 in Asia/Shanghai. On npm, @ui-sdk/react@0.1.0-beta.1 was published at 2026-11-12 17:09:05 UTC (01:09 in Asia/Shanghai), and @ui-sdk/core@0.1.0-beta.1 at 17:12:06 UTC (01:12).

According to public X data, as of 13 November 2026, 04:23 Asia/Shanghai:

If you are already following other Vercel agent tools, you can also compare How to use Vercel agent-desktop and How to use Cursor Live Apps.

Install 0.1.0-beta.1 in a React 19 project

The official React installation docs require React 19 and React DOM 19 or newer. We scaffolded a minimal app with create-vite@9.3.4 and the react-ts template, which shipped react@19.3.1 / react-dom@19.3.1 and @types/react@19.3.0 (the docs also ask TypeScript users for @types/react 19.2.10 or newer).

bash
npm install @ui-sdk/react @ui-sdk/core

We ran this at 04:20 on 13 November 2026, Asia/Shanghai. npm reported added 2 packages, and audited 31 packages in 797ms. Wall time was about 0.86 seconds, exit code 0. npm ls showed:

text
@ui-sdk/core@0.1.0-beta.1
@ui-sdk/react@0.1.0-beta.1
react@19.3.1
react-dom@19.3.1

Both SDK packages are licensed Apache-2.0. The @ui-sdk/react peer dependencies are react / react-dom >=19 and @ui-sdk/core ^0.1.0-beta.1. For other frameworks, the official README says to swap @ui-sdk/react for @ui-sdk/vue, @ui-sdk/svelte, @ui-sdk/solid, or @ui-sdk/web, and still install @ui-sdk/core alongside it.

Build the official search-field example

The official README walkthrough is a search field with a Clear button: Clear is shown only when the input has text, and pressing it empties the field and moves focus back to the input. We copied the primitive and the React rendering into src/lib/search-field.ts and src/components/Search.tsx, and also rendered the Toggle from the official First Component guide in App.tsx.

ts
import { createFocusRecovery, definePrimitive } from "@ui-sdk/core"

const searchField = definePrimitive({
  name: "search-field",
  state: () => ({ value: "" }),
  api: (context) => ({
    set: (value: string) => context.store.set({ value }),
    recovery: createFocusRecovery({ fallback: () => context.element("input") }),
  }),
  slots: (slot) => ({
    input: slot({
      attrs: (state) => ({ value: state.value }),
      on: {
        input: (event, { api }) =>
          api.set((event.target as HTMLInputElement).value),
      },
    }),
    clear: slot({
      present: (state) => state.value !== "",
      attrs: () => ({ type: "button" }),
      press: ({ api }) => api.set(""),
      bind: (el, part) => part.api.recovery.bind(el, part),
    }),
  }),
})

export { searchField }
tsx
import { createParts } from "@ui-sdk/react/primitive"
import { searchField } from "../lib/search-field"

const parts = createParts(searchField, { input: "input", clear: "button" })

const SearchField = parts.Root
const SearchFieldInput = parts.Input
const SearchFieldClear = parts.Clear

function Search() {
  return (
    <SearchField>
      <SearchFieldInput placeholder="Search" />
      <SearchFieldClear>Clear</SearchFieldClear>
    </SearchField>
  )
}

export { Search }

We then ran npm run build (the script is tsc -b && vite build). The build finished at 04:20 on 13 November 2026, Asia/Shanghai. Vite 8.3.8 reported 189 modules transformed and built in 175ms. The full command took about 0.88 seconds and exited 0. We did not open a browser to click the search field; a successful build is the result of this step.

Add the UI SDK skill for Claude Code, Codex, and Cursor

To have an agent follow the official workflow — choose behaviors, define a primitive, render it, and test it — the docs give this install command:

bash
npx skills add vercel-labs/ui --skill ui-sdk

We ran it in the same React project root. Wall time was about 6.71 seconds, exit code 0. After detecting the environment, the installer copied the skill to ./.agents/skills/ui-sdk in the project. The output listed Cursor, Codex, and a number of other agents as targets. The official docs also note that the same skill ships with @ui-sdk/core at node_modules/@ui-sdk/core/skills/ui-sdk/SKILL.md, always matching the installed package version. If your agent does not support skills, point it at that file instead.

The official React quick start also asks you to add a note to AGENTS.md, creating the file if needed. We wrote the following, pointing at the packaged docs:

text
Before using ui-sdk, follow the ui-sdk skill if it is installed, and read
node_modules/@ui-sdk/react/docs/llms.txt. To build a new component, also search
node_modules/@ui-sdk/react/docs/core.md by heading, and read rendering.md next
to it.

For other frameworks, swap @ui-sdk/react in that path for the matching package. For skill install locations and how they trigger in different clients, see How to use Agent Skills and How to install and use tstack. If you also need hooks around tool calls, see How to set up Claude Code / Codex / Cursor Agent Hooks.

The official sample prompt for an agent looks like this (change the framework and the interaction to match your app):

text
Use ui-sdk to build a five-star rating in React.
Arrow keys should move between stars and choose a rating.
Use our existing styles and test the keyboard behavior.

What we ran: Claude Code and Codex each built a five-star rating

We handed the project — SDK installed, AGENTS.md written, ui-sdk skill already added — to Claude Code and to Codex. The prompt was the official example above, plus instructions to keep the existing search-field, wire the rating into App.tsx, and run npm run build. Both runs used this site's API (configuration is in the next section) and an isolated HOME. We deleted the configs that contained the key afterwards. For Claude Code we also copied the skill into .claude/skills/ui-sdk in the project, because that is the directory it reads by default.

Claude Code 2.1.319, model claude-opus-5-5, started at 04:22:01 and finished at 04:23:06 on 13 November 2026, Asia/Shanghai. Wall time was 65.02 seconds. The JSON result reported duration_ms 64442, num_turns 20, and subtype success. It did not use the shipped Rating component. Instead it wrote src/lib/rating.ts with definePrimitive, createChange, and createRovingFocus from @ui-sdk/core, then rendered src/components/Rating.tsx with createParts. The five stars are role="radio" buttons; arrow keys move focus and update the value. Its own npm run build exited 0 in about 0.9 seconds and transformed 191 modules. We rebuilt in the same directory afterwards: exit code 0, about 0.79 seconds.

Codex CLI 0.167.0, model gpt-6.1-sol, started at the same time and finished at 04:23:12. Wall time was 70.92 seconds. It took the other official path: it imported Rating and RatingItem from the shipped @ui-sdk/react/rating entry, wrote src/components/Rating.tsx, and added tests that use createAgent(). It reported 2 tests passed with exit code 0, and a build that exited 0 in 0.68 seconds (196 modules, Vite printed built in 147ms). We then reran npx vitest run --environment jsdom (Vitest 5.1.0): Test Files 1 passed, Tests 2 passed, 802ms. A second build exited 0 with built in 157ms. The two tests cover arrow-key selection with a single tab stop, and an agent calling snapshot / act({ action: "setValue", args: [4] }) to set the rating to 4. Codex noted that it did not do visual checks in a browser.

Cursor can install the same skill (the installer listed it as a target), but we did not run a generation task inside Cursor. Whether it triggers cleanly depends on your local Cursor version.

Let an agent read and operate components on the page

After the components render, an agent can also read state and call actions through the official agent bridge. The React usage, according to the Agents docs, is:

ts
import { createAgent } from "@ui-sdk/react/agent"

const agent = createAgent()

agent.snapshot() lists the ui-sdk components on the page, their state, and their available actions. A text field with an accessible name, for example, can expose setValue and clear. You then call:

ts
await agent.act({
  steps: [{ ref: "Project name", action: "setValue", args: ["Atlas"] }],
})

Other frameworks import from @ui-sdk/vue/agent, @ui-sdk/svelte/agent, @ui-sdk/solid/agent, or @ui-sdk/web/agent. The second Codex test used this API: it ran setValue(4) on the rating, and the test passed. You can also pass an allow callback to createAgent to approve or reject requested actions.

Point Claude Code, Codex, or Cursor at an API Key from this site

The UI SDK itself is not a model API, so you do not configure model pricing for it. If you want Claude Code, Codex, or Cursor to use models from this site to build components with the skill, point the client at this site and paste your API Key. The three clients are listed side by side; use the one you already work with.

For Claude Code, write ~/.claude/settings.json:

json
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://api.aicodewith.ai",
    "ANTHROPIC_AUTH_TOKEN": "your AICodeWith API Key"
  }
}

For Codex, write ~/.codex/config.toml. The base_url must be https://api.aicodewith.ai/chatgpt/v1, not /v1. Use the global experimental_bearer_token, and set name to "aicodewith":

toml
model_provider = "aicodewith"
model = "gpt-6.1-sol"

[model_providers.aicodewith]
name = "aicodewith"
base_url = "https://api.aicodewith.ai/chatgpt/v1"
wire_api = "responses"
experimental_bearer_token = "your AICodeWith API Key"

In Cursor you can enter a custom API and model name in the model settings. We did not run that path, so whether it connects depends on your local Cursor version.

If you want a key from this site for a generation run like this one, you can create it below.

Create API Key →

Common errors and fixes

Error or symptomWhy it happensWhat to do
Install or typecheck reports an unsatisfied React peer@ui-sdk/react requires React 19+Upgrade react and react-dom to 19 or newer; TypeScript users should also upgrade @types/react to 19.2.10 or newer
You installed only @ui-sdk/react and import or runtime fails@ui-sdk/core is a peer dependency; the docs ask you to install both so you share one copy of the coreAlso run npm install @ui-sdk/core
Cannot find module '@ui-sdk/react' or a component name is missingThe docs state there is no root barrel export; components are imported from their own entriesImport like import { Dialog, DialogTrigger } from "@ui-sdk/react/dialog"
The agent ignores the ui-sdk skill or cannot find the docsThe skill is not in a directory that client reads, or AGENTS.md does not point at the packaged llms.txtRerun npx skills add vercel-labs/ui --skill ui-sdk, update AGENTS.md as the docs describe, or point the agent at node_modules/@ui-sdk/core/skills/ui-sdk/SKILL.md
Codex says the model does not exist, but you used a model that is listedThe base_url was set to https://api.aicodewith.ai/v1Change it to https://api.aicodewith.ai/chatgpt/v1
The build succeeds, but the Clear button never appears or focus does not return to the inputpresent or createFocusRecovery was not wired as in the official example, or Clear is not inside the same primitive RootCompare your present, press, and bind with the official search-field example
After a minor upgrade, the API no longer matches the docs you bookmarkedThis is a beta, and the official docs say APIs may still changeTrust the packaged docs in node_modules/@ui-sdk/*/docs/ for the version you installed, not only the website, which may already have moved on

FAQ

How is the UI SDK different from a typical component library?

According to the official docs, behaviors live in framework-free @ui-sdk/core, and the adapters only render them. Shipped components such as Select, Dialog, Tabs, and Rating are built on the same behaviors, and they are unstyled, with no provider and no portal. You can also skip the shipped components entirely and compose your own interface with definePrimitive.

Do I have to use React?

No. Official adapters also exist for Vue, Svelte, Solid, and Web Components. This run used the React 19.3.1 path. For other frameworks, swap in the matching package as the official docs describe. We did not rerun the build on those frameworks this time.

Does an agent have to use the skill?

No. The official docs say: if your agent supports skills, run npx skills add vercel-labs/ui --skill ui-sdk. If it does not, point it at node_modules/@ui-sdk/core/skills/ui-sdk/SKILL.md or at the packaged llms.txt. We confirmed that both files were present after install.

Can I use the beta in production?

The official docs state that the SDK is in beta, that APIs may still change, and they point to the Vercel Public Beta Agreement. Whether you use it in production is a decision you make under those terms and your own risk tolerance. This article only records what we saw for install, build, and agent-generated components.

Why didn't this run include Cursor?

The installer already listed Cursor as a skill target, but we did not start a generation task inside Cursor. The Cursor configuration in this article follows this site's usual setup and was not checked in this run.

If you want to run Claude Code or Codex against models from this site, you can create an API Key first.

Create API Key →

相关文章

What Is AWS Emulator and How Do You Install It? Test AWS Apps Locally with Claude Code and Codex (Tested on 1.0.322)

What Is AWS Emulator and How Do You Install It? Test AWS Apps Locally with Claude Code and Codex (Tested on 1.0.322)

AWS Emulator is AWS's official local emulator of its service APIs, generally available since November 11, 2026 (US time). It has no additional service fee, its source is open, it needs no AWS account, and it covers more than 200 services. We tested version 1.0.322 on Debian 13. This guide covers the install commands, pointing the AWS CLI at the local endpoint to create an S3 bucket and a DynamoDB table, the errors we hit, and how to let Claude Code, Codex and Cursor write and test code against the emulator.

What Is T3 Code and How Do You Install It? Connect Claude Code and Codex, Use a Third-Party API Key, Fix Common Errors (Tested on 0.1.9)

What Is T3 Code and How Do You Install It? Connect Claude Code and Codex, Use a Third-Party API Key, Fix Common Errors (Tested on 0.1.9)

T3 Code is pingdotgg's open-source control surface for coding agents. It ships no model of its own; it drives the Claude Code, Codex, Cursor and other CLIs already on your machine. We tested T3 Code 0.1.9 on Linux. This guide covers the install commands, how to point Claude Code and Codex at an AICodeWith API Key so T3 Code can drive them, a full run of both agents with the t3 thread command, and the errors we hit along the way with their fixes.