v0.1.9

AI 接入

AI 编程助手需要先读取 Apollo Design 的文档,再生成代码。Apollo 是独立发展的 Vue 3 原生组件库,不能直接套用 React 或其他组件库的 API。

把文档交给 AI

每个组件都有 components/<name>.md 和 components/<name>.en.md,指南有 guide/<slug>.md 和 guide/<slug>.en.md。完整文件可能超过模型上下文,日常优先使用索引和单页。静态文件跟随文档站部署更新,开头标注 UI 版本与源码提交;使用旧版本项目时需核对版本。

可以把这段要求放进项目的 AI 指令文件:

本项目使用 Apollo Design(Vue 3)。编码前核对已安装的 @apollo-design/ui 版本,
读取 https://apollocmh.github.io/apollo-design-ui/llms.txt 中对应组件的文档和示例。
Props、Slots、Emits、v-model 和导入方式以 Apollo 文档为准,不推测其他 UI 库的 API。
先引入 @apollo-design/theme/tokens.css,再引入 @apollo-design/ui/style.css。
缺少 API 信息时先查询;不要编造属性、事件或包名。

这些文件用于提供上下文。AI 客户端不一定自动发现或读取 llms.txt,需要在提示词或项目指令中明确提供链接。

本地 MCP

@apollo-design/mcp 提供 stdio MCP 服务,文档随包携带,查询时无需网络、账号、API Key 或在线服务器。通过 npm 分发,选择与项目 UI 相同的版本(当前为 0.1.9)。首次使用 npx 会下载包,后续查询直接读取随包文档。

npx -y @apollo-design/mcp@0.1.9 --project /absolute/path/your-vue-project

在支持 MCP 的客户端中加入配置,替换项目绝对路径(不同客户端配置文件位置可能不同):

{
  "mcpServers": {
    "apollo-design": {
      "command": "npx",
      "args": [
        "-y",
        "@apollo-design/mcp@0.1.9",
        "--project",
        "/absolute/path/your-vue-project"
      ]
    }
  }
}

需要 Node.js 22.12+。--project 指向已安装 @apollo-design/ui 的应用目录;服务启动时核对精确版本,不匹配或无法解析该包会报错。省略该参数可浏览随包文档,但会明确标记项目版本未验证。

四个只读工具:search_components 搜索组件和指南,get_document 获取 API 或指南,list_examples 列出示例,get_example 获取真实 Vue 源码及本地辅助文件。工具不执行示例、不修改项目;文档、源码、公开导入路径与网站使用同一条生成链路。

Powered by Vue 3 + ViteApollo Design · Vue NativeGitHub