AI Agents
How to point an AI coding agent at the correct usage of @k8ordo/ui. The design guide and the references ship inside the npm package, and Storybook is available over MCP.
Agent setup
Use `@k8ordo/ui` for UI. Before writing or changing UI, read
`node_modules/@k8ordo/ui/docs/GUIDE.md`, then follow only the
`docs/references/*.md` links it lists that the task actually needs.
Colors, spacing, radii and font weights go through semantic tokens —
never raw values such as `bg-teal-500` or `font-semibold`.
Look up component props in `docs/references/components.md` (the AI chat
components in `docs/references/ai-chat.md`, the generative UI adapters in
`docs/references/generative-ui.md`) instead of recalling them;
a component that is listed in none of them does not exist.Paste this into your project’s CLAUDE.md or AGENTS.md. The docs ship inside the npm package, so the agent reads the version you installed. It has the real props to go on instead of recalling ones that do not exist or are out of date.
Available docs
docs/GUIDE.md- The design guide to read first
docs/references/*.md- References for components, types, and design rules
docs/llms.txt- An index of the docs for LLMs
design.md- The design token spec
@k8ordo/ui/props.json- The props of every component, as JSON
https://main--687a213c85e2e4589d8db1bb.chromatic.com/mcp- The MCP endpoint of the published Storybook
GUIDE.md and the references are in both node_modules and this site. design.md is only on this site, and props.json only in the package. The package’s docs/llms.txt indexes @k8ordo/ui; the site’s /llms.txt indexes every package.
Storybook over MCP
{
"mcpServers": {
"k8ordo": {
"type": "http",
"url": "https://main--687a213c85e2e4589d8db1bb.chromatic.com/mcp"
}
}
}Add this to your MCP client’s configuration. The agent can then look up each component’s docs, props, and stories.
Generated props and tokens
The props in props.json and the component reference are generated from the types, and the tokens in design.md from the CSS. CI fails when either drifts from the implementation, so the docs never fall behind the code.