SKILL.md
Wire UI ships a SKILL.md file — a machine-readable documentation format designed specifically for AI coding agents. While llms.txt provides a reference index, SKILL.md provides actionable workflows, decision trees, and guardrails that help AI agents write correct Wire UI code.
What is SKILL.md?
SKILL.md is an open standard for structuring product documentation for AI agents. It goes beyond API references by including:
- Decision trees — “Need a dropdown selection? Use
Select. Need a search with results? UseSearch.” - Anti-patterns — common mistakes AI agents should avoid
- Workflow guidance — step-by-step patterns for compound components and validation
- Guardrails — constraints like “Button defaults to
type='button'” and “validation is always consumer-controlled”
SKILL.md complements llms-full.txt — it does not replace it. Use both for the best AI-assisted development experience.
Available File
| File | Description |
|---|---|
SKILL.md | Complete AI agent skill with decision trees, anti-patterns, and all component APIs |
Usage with AI Tools
Claude Code
Claude Code automatically reads SKILL.md from your project root when it is present. No configuration needed — just clone the repo and start coding.
Cursor
- Open Cursor Settings → Features → Docs
- Add the raw GitHub URL for
SKILL.md - Reference it with
@wire-uiin chat
Windsurf
Reference the file in your prompt:
@https://raw.githubusercontent.com/wire-ui/wire-ui/main/SKILL.mdOther AI Tools
Any AI coding tool that reads project files will pick up SKILL.md from the repo root. For tools that accept URLs, use the raw GitHub link above.
What’s Inside
The SKILL.md file includes:
- Core concepts — data attributes, compound components, asChild, consumer-owned validation
- Complete component reference — all 27 components with props, parts, and data attributes
- Hooks —
useInteractiveStateanduseClickOutside - Decision trees — choosing form components, overlays, and styling approaches
- Anti-patterns — 7 common mistakes with explanations
Related
- LLMs.txt — AI-readable documentation files
- MCP Server — Direct tool access for AI coding agents