助手指南
面向 AI 助手
通过 MCP 服务器查询组件，或安装完整的 Agent Skills，按需加载组件知识。本页保留直接读取注册表的流程。编码助手可以检查源码与依赖，再通过 shadcn-vue 安装到用户项目。
先了解接入流程
读取现有能力
从文档与注册表获取组件名称、API 和依赖。
安装并显式注册
使用真实安装项和公开入口，按当前项目框架接入。
运行并核对结果
检查生成结果、交互状态与需要的服务端能力。
Agent skill
安装完整技能请前往 Agent Skills。它包含双语组件参考，并支持 npx skills 安装。需要项目级约定时，合并 AGENTS.md 中的相关段落。
接口
- 打开
/llms.txtllms.txt符合 llmstxt.org 格式的 Markdown 索引。
- 打开
/r/registry.json注册表索引全部组件的 JSON 目录。
/r/{slug}.json组件详情包含全部文件、依赖与源码的 shadcn-vue 安装项。
- 打开
/registry.jsonshadcn 目录兼容注册表目录格式的组件清单。
- 打开
/r/orvui-theme.json主题安装项包含语义颜色与主题配置的安装资源。
/r/{slug}/raw.txt原始源码对应默认组件的纯文本 Vue 源码；完整依赖见组件详情。
助手流程
读取目录与组件详情，检查文件和依赖，再通过 shadcn-vue 安装完整条目。
agent.ts
// 1. Discover what exists
const index = await fetch('https://orvui.efu.me/r/registry.json').then(r => r.json());
// 2. Fetch a component selected from index.items[].name
const entry = await fetch(`https://orvui.efu.me/r/${slug}.json`).then(r => r.json());
// 3. Inspect the source targets and dependencies before installing
console.log(entry.files.map(file => file.target), entry.dependencies);
// 4. Install the complete item with shadcn-vue
await runShell(['pnpm', 'dlx', 'shadcn-vue@2.8.2', 'add',
`https://orvui.efu.me/r/${slug}.json`]);shadcn 流程
安装项同时提供源码文件和包依赖。组件直接使用 shadcn 语义颜色工具类，因此可以继承目标应用的主题，无需额外的 orvui 专用颜色变量。
终端
# Direct URL: no published registry namespace is required
npx shadcn-vue@2.8.2 add https://orvui.efu.me/r/animated-toast-stack.json条目结构
内部工具（例如 lib/utils.ts）以 registry:lib 文件随条目内联分发，助手无需逐一追踪导入。target 指定写入用户项目的位置，content 包含完整源码。
r/swap.json
{
"name": "swap",
"type": "registry:block",
"title": "Multi-chain Swap",
"description": "Cross-chain swap widget with chain + token selectors, morphing views, animated flip and quote.",
"dependencies": [
"motion-v@^1.10.0",
"lucide-vue-next@^0.468.0"
],
"meta": {
"category": "blocks",
"productVersion": "0.1.1"
},
"files": [
{
"path": "registry/orvui/blocks/swap/MultiChainSwap.vue",
"target": "src/components/orvui/blocks/swap/MultiChainSwap.vue",
"type": "registry:component",
"content": "..."
},
{
"path": "registry/orvui/lib/utils.ts",
"target": "src/components/orvui/lib/utils.ts",
"type": "registry:lib",
"content": "..."
}
]
}生成式 UI
希望模型将这些组件组合为实时界面？按照 OpenUI 集成指南 注册自定义组件库、生成系统提示词，并在 OpenUI Lang 流式到达时渲染交互界面。