Getting started
AI agents
Give your coding agent the 0xui docs as Markdown, a skill, the shadcn MCP server or in-browser tools.
0xui is built to be read by agents as well as people. Pick whichever fits how your agent works. They all serve the same docs.
Agent skill
Section titled “Agent skill”The skill tells an agent how to set up 0xui, which component fits which job, and the rules the components follow. Install it with the skills CLI:
npx skills add https://0xui.ioThe site publishes it at /.well-known/agent-skills/index.json, following the Agent Skills discovery RFC. You can also install it from GitHub with npx skills add fimbul-lab/0xui --skill 0xui.
Markdown docs
Section titled “Markdown docs”Every page has a Markdown version without the live demos. Use Copy page at the top of a page to paste it into a chat, or point your agent at:
| URL | What it returns |
|---|---|
/llms.txt |
Setup and a one-line description of every page, grouped like the sidebar. Start here. |
/llms-full.txt |
Every page in one file. |
Any page URL + .md |
One page, like /components/balance.md. |
/r/<name>.json |
The registry item: dependencies and the full source of every file. |
/r/<name>-demo.json |
A runnable example for every component and block. |
/props/<name>.json |
The component’s props, generated from its TypeScript types. |
A request for a page with Accept: text/markdown gets the Markdown instead of the HTML. Each HTML page also links its Markdown version with <link rel="alternate" type="text/markdown">, and every response links /llms.txt and the skill index in its Link header.
shadcn MCP server
Section titled “shadcn MCP server”The shadcn MCP server lets an agent browse, search and install items from any registry in your components.json, including @0xui. Add the 0xui registry first, then set up your client:
npx shadcn@latest mcp init --client claudeOther clients: cursor, vscode, codex and opencode. Then ask in plain words, like “add a wallet button and an ETH balance to the header using @0xui”. The server finds each component’s example as <name>-demo.
WebMCP
Section titled “WebMCP”In a browser with WebMCP, this site registers tools the browser’s agent can call instead of reading pages:
| Tool | What it does |
|---|---|
list_docs |
Every page with a one-line description. |
search_docs |
Full-text search, returning page ids and excerpts. |
get_doc |
One page as Markdown, by id, name or URL. |
get_registry_item |
What shadcn add installs for an item, with its source. |
The tools only read the docs. They don’t change anything in your browser or your project.
In your app
Section titled “In your app”0xui components are built so agents can drive the apps you make with them, too:
- Agent Tools registers WebMCP tools for the wallet: who is connected, balances, chains, gas.
- Buttons that send, sign or approve carry
data-agent-confirm, so a browser agent asks a person before pressing them. data-phaseanddata-errorsay what state a component is in and why an action failed. See Conventions.
