HQ UI

MCP Server

Use the shadcn MCP server to browse, search, and install components from registries.

Registry

To use the HQ UI registry, add the following entry to your components.json:

{
  "registries": {
    "@hq": "https://hq-ui.vercel.app/r/{name}"
  }
}

Initialize

Choose your client and run one of the following commands:

npx shadcn@latest mcp init --client codex

Add the following to ~/.codex/config.toml:

React Aria MCP

If you work with AI and use React Aria Component, you should consider using the React Aria MCP server.

npx codex mcp add react-aria -- npx @react-aria/mcp@latest

Add the following to ~/.codex/config.toml:

If you use both MCP servers, your config should look like this:

Skills

Skills give AI assistants like Claude Code project-aware context about hq-ui. When installed, your AI assistant knows how to find, install, compose, and customize components using the correct APIs and patterns for your project.

npx skills add https://github.com/hq-kit/ui --skill hq-ui

Structure

hq-ui/
├── SKILL.md              # Main skill definition
└── rules/
    ├── styling.md        # Semantic colors, cn, size-* shorthand, intent prop
    ├── icons.md          # Tabler Icons rules, components that control icon sizing
    ├── forms.md          # Fieldset, FieldLegend, TextField, FieldError, FieldDescription patterns
    ├── components.md     # HTMLHQ UI component mapping
    └── cli.md            # Search & install missing components from the registry

Markdown files

Every page in the docs is also published as a standalone Markdown file.

To view it, add .md to the end of the page URL. You can also use the Copy page button on each page to copy the full content to your clipboard as Markdown.

llms.txt

The llms.txt file provides an index of all Markdown pages available across the React Aria documentation.

References