SKILL.md
757 tokens · o200k_base · 3,500 bytes
Prerequisites:
- Storybook must be installed in the project. Invoke the
$storybook:initskill to set up Storybook, but only if the user explicitly invoked this skill and approves a Storybook installation. - Storybook must be at least 10.6. (While 10.6 is unreleased,
nextsatisfies this — 10.6.0-alpha.x. Any canary build,0.0.0-pr-*, also qualifies.) Treat a request to set up or install Storybook as approval to perform any required Storybook upgrade. For other requests, invoke the$storybook:upgradeskill only after the user explicitly approves an upgrade. - Ensure
@storybook/addon-mcpis installed. If it is missing, install it withnpx storybook add @storybook/addon-mcp.
In sandboxed Codex environments, run every Storybook CLI command with require_escalated — sandbox network/port restrictions can otherwise cause confusing failures (e.g. the dev server finds no free port to bind to).
Run the Storybook dev server and every Storybook CLI command from the same working directory: the package where Storybook is installed (in a monorepo often a leaf package such as packages/ui).
For docs, props, or usage questions, use npx storybook tools docs list followed by npx storybook tools docs show before inspecting source files. Fall back to source inspection only when the documentation commands are unavailable or return no relevant documentation.
Run npx storybook skills stories and read the output in its entirety to get the mandatory, ordered workflow for working on UI changes, writing stories, and keeping stories in sync with every frontend component you create, modify, or delete. This workflow explains how to write stories, preview stories, and display a curated Storybook review.
Before invoking any npx storybook tools command for the first time in a session, run it with --help appended and read the output fully. The workflow only names the commands; each command's argument shape and usage rules (which fields to include when) live in its own help output. Never guess a command's arguments from its name — a validation error only reports missing required fields, not the optional fields the workflow expects you to provide.
Some commands require a running Storybook dev server:
- Reuse a dev server that already serves this project's Storybook (probe the URL, usually
http://localhost:6006) instead of starting a second one. Otherwise start one in the background, using the project's preferred package manager and existingpackage.jsonStorybook script (e.g.npm run storybook) instead of inventing a new command whenever possible. Wait until the URL responds before running commands that need it. - The dev server is part of the deliverable, not a temporary verification tool: leave it running when your work is done so the user can keep browsing stories. Never kill it after verification.
- When the
control-in-app-browserskill is available, finish by opening the Storybook review or story preview URL you will include in your final response in the in-app browser through that skill, so the user sees the result side by side inside Codex.
Discovery context
Discovered by repository scan. No exact path reference found in the snapshot’s root AGENTS.md.