跳至正文
文档

AI & llms.txtAI 与 llms.txt

让 AI 编辑器与 Agent 读取本站文档,并通过 shadcn MCP 检索和安装组件。

llms.txt

站点按 llms.txt 约定提供两个纯文本入口:

  • /llms.txt:站点简介、安装方式、组件清单与文档链接。适合当作索引喂给模型。
  • /llms-full.txt:全部文档与博客的 MDX 原文。适合一次性放进上下文。

两个文件都在构建时生成,内容与页面保持一致。

在 AI 编辑器中使用

最简单的方式:让 Agent 先读 https://yiui.dev/llms.txt,从中找到组件清单和每个条目的 JSON 地址,再按安装页里的命令运行。

向 Agent 提需求时,建议明确写出:

  • 使用 Yi UI 的哪个条目,例如「用 @yiui/grid-layout 搭页面骨架」。
  • 项目要先按安装初始化 shadcn,底座选 Base UI;让 Agent 先看 components.json 的 style 是否以 base- 开头。
  • 安装前先加 --dry-run 看会写入哪些文件,已有同名文件默认不要覆盖。
  • 颜色只用主题变量,不要硬编码。
  • 安装后源码属于项目,可以按需修改。

如果 Agent 的运行环境设置了 SOCKS 代理(ALL_PROXY),shadcn CLI 可能以 other side closed 失败,让它用 env -u ALL_PROXY -u all_proxy 去掉该变量再运行,详见安装。

shadcn MCP

shadcn 官方提供 MCP 服务,可以让 AI 编辑器直接检索和安装 Registry 里的条目。先在 components.json 里配置好 @yiui 命名空间(见 Registry 与命名空间),然后初始化 MCP:

终端
pnpm dlx shadcn@latest mcp init --client claude

--client 可选 claude、cursor、vscode、codex 等。也可以手动写配置,例如 Claude Code 的 .mcp.json:

.mcp.json
{
  "mcpServers": {
    "shadcn": {
      "command": "npx",
      "args": ["shadcn@latest", "mcp"]
    }
  }
}

配置完成后,可以直接这样对 Agent 说:

  • 「列出 @yiui 里所有组件」
  • 「把 @yiui/auth-01 加到项目里」