Skip to content

Documentation

For agents

Give a coding agent Mizen's docs as Markdown, so it uses real components and APIs instead of guessing.

idle

Start with llms.txt

/llms.txt lists every component and guide with a link to its Markdown. Point an agent there first.

Markdown for every page

Every component page has a Markdown version at /docs/components/<slug>/markdown. It includes the description, recommendations, usage boundaries, API, import line, anatomy, and examples. Guides have one at /docs/<guide>/markdown.

Use Copy page on any component page to copy that Markdown, or open it in ChatGPT or Claude.

Consumer skill

The Mizen consumer skill tells an agent how to find components and compose them without inventing APIs. Add it to your agent's skills.

Metadata

/docs/components/<slug>/metadata returns a component's name, category, status, description, and API as JSON.

Agent application boundaries

Composer presents application-owned drafts and working state. It does not connect to a provider, send messages, or run tools.

TanStack AI is the planned runtime integration. Live provider transport remains deferred until an actual app needs it. The docs examples do not implement streaming transport, cancellation, tool execution, or approval persistence. Keep those responsibilities explicit in the application.