298 complete patterns 286 comparisons Static artifacts

Agent-first UX pattern context

Build-time generated files for agents that need to choose source-backed interaction patterns, load only the relevant contracts, and review generated UI without a server-side runtime.

Open llms.txt

Copy-paste activation

Paste this one message into an agent that can fetch URLs. No download, install step, package manager, or server runtime is required.

One-message setup

Before generating or reviewing UI, use UX Patterns Guide as external context.

Read https://uxpatternsguide.com/agent/start.md for the workflow, then search https://uxpatternsguide.com/agent/index.json for 2-5 candidate patterns.

Load only the relevant pattern contracts from https://uxpatternsguide.com/agent/patterns/{id}.md. If candidates overlap, load the related comparison pack from https://uxpatternsguide.com/agent/comparisons/{id}.md. Before final output, apply https://uxpatternsguide.com/agent/anti-pattern-checklist.md.

In your answer, name the selected pattern, rejected alternatives, required states, interaction contract, common generated-UI mistakes avoided, and review questions. Do not load the full catalog unless you are building an offline index.

Open copy-paste file Open start guide

Optional deeper integration

Use these only when an agent supports persistent skills or you are building local retrieval. The copy-paste instruction above is the default path.

Agent Skill entrypoint

Use this `SKILL.md` in Codex, Claude Code, or any Agent Skills compatible client.

https://uxpatternsguide.com/agent/skills/ux-patterns/SKILL.md

Open skill

Starter prompt

Use when a coding agent has not installed the skill but can fetch static URLs.

Use UX Patterns Guide before generating or reviewing UI.
1. Read https://uxpatternsguide.com/agent/start.md
2. Search https://uxpatternsguide.com/agent/index.json for 2-5 candidate patterns.
3. Load only relevant pattern contracts from https://uxpatternsguide.com/agent/patterns/{id}.md
4. Load comparison packs from https://uxpatternsguide.com/agent/comparisons/{id}.md when candidates overlap.
5. Apply https://uxpatternsguide.com/agent/anti-pattern-checklist.md before final output.
Return the selected pattern, rejected alternatives, required states, interaction contract, and review questions.

Open review workflow

Static artifact map

Agents should start small, then retrieve only the contracts and comparisons needed for the current UI task.

Copy-paste prompt One message to paste into an agent that can fetch URLs. Root discovery Curated first-read file for agents that start from the domain. Start guide Retrieval order and required agent output. Compact index Small searchable map of pattern IDs, fit rules, keywords, and URLs. Pattern contracts One focused markdown and JSON file per pattern. Comparison packs Decision rules for nearby alternatives. Portable skill Agent Skills entrypoint for Codex, Claude Code, and compatible clients.

Layer 1: Compact index

Use for retrieval and candidate selection. It carries IDs, keywords, fit rules, required-state summaries, and direct artifact URLs.

298 patterns: Complete entries only; 0 stubs excluded.
14 categories: Useful for coarse filtering before loading contracts.
Small first context: Avoid loading the full Markdown export unless building an offline index.

Open index JSON

Layer 2: Pattern contracts

Each pattern has its own markdown and JSON file with required states, interaction contract, accessibility, keyboard behavior, and failure modes.

Markdown: `/agent/patterns/{id}.md` for agent-readable contracts.
JSON: `/agent/patterns/{id}.json` for custom local retrieval.
Evidence: Source IDs, notes, and verification dates stay attached.

Open example contract

Layer 3: Comparisons

Decision packs prevent agents from picking a component by name when nearby patterns would fit better.

286 packs: Rules for modal vs sheet, toast vs inline error, table vs grid, and other close calls.
Rejected alternatives: Use these to explain why a different pattern was not selected.

Open comparison index

Review layer

Use after generation to catch known failures before code review or handoff.

26 anti-patterns: Static checklist for common generated-UI failures.
Review workflow: Names missing states, contract breaks, and required revisions.
Full exports: Still available for offline indexing and custom tooling.

Open anti-pattern checklist