Skip to page content

AI Agents

AI 编码助手了解的是"某个 Quasar",未必是你的那个。@quasar/mcp 包是一个 MCP(Model Context Protocol,模型上下文协议)服务器,它能把你项目中所安装的确切 Quasar 版本的文档页面和组件 API 离线交给任何支持 MCP 的助手。

环境要求
  • Quasar UI v2.33+
  • @quasar/app-vite v3.9+(如果你的项目使用它)

工作原理

文档随包一起发布:关于组件、插件、指令、composable、util 和样式的页面在 quasar 内,关于 CLI、其各模式及配置的页面在 @quasar/app-vite 内。每个组件、插件和指令的 API 一如既往随 quasar 发布,并且自 v2.33 起还以本站所展示的紧凑形式发布。服务器会从你项目的 node_modules 中读取它们,因此:

  • 答案描述的是你所运行的版本,而非最新发布版;
  • 不会从 quasar.dev 拉取任何内容,可离线工作;
  • 升级某个包即升级它的文档。
TIP

这些页面与你在本站阅读的是同一批;每个页面还带有一个 Markdown 按钮(右上角)和一个 .md 同名 URL,供浏览网页的助手使用。

设置

在你的 MCP 客户端中注册该服务器。项目里不会安装任何东西:npx 会启动最新的服务器发布版,因此它会自我保持更新;当你离线时,它会启动上次缓存的副本(retries 标志正是让这一过程保持快速的关键)。

{
  "mcpServers": {
    "quasar": {
      "command": "npx",
      "args": ["-y", "--fetch-retries=0", "@quasar/mcp@latest"]
    }
  }
}

服务器会服务它被启动所在的项目——当配置文件位于项目内时,每个客户端都是这么做的。如果你的客户端从别处启动服务器,请在参数中加上 "--project", "/path/to/project"。

Monorepo

当在工作区根目录打开时,服务器会以你的代码相同的方式解析这些包,因此提升(hoisted)布局(npm、Yarn)会在根目录被找到。而对于 pnpm,每个应用保留自己的 node_modules,因此当根目录没有时,服务器会向下查找若干层:那里有一个 Quasar 应用就服务它,并告知助手是哪一个。若有多个应用,则取第一个(完整应用优先于仅依赖 quasar 的包,否则按路径顺序),并把其余的告知助手;传入 "--project", "apps/web" 可服务指定的那个。若显式给出,某个目录会被原样服务。

Claude Code

claude mcp add quasar -- npx -y --fetch-retries=0 @quasar/mcp@latest

在原生 Windows(非 WSL)上,Claude Code 通过命令行 shell 启动 npx 服务器:

claude mcp add quasar -- cmd /c npx -y --fetch-retries=0 @quasar/mcp@latest

Codex

codex mcp add quasar -- npx -y --fetch-retries=0 @quasar/mcp@latest

这会把服务器写入 ~/.codex/config.toml;项目也可以在自己的 .codex/config.toml 中携带相同的配置段:

[mcp_servers.quasar]
command = "npx"
args = ["-y", "--fetch-retries=0", "@quasar/mcp@latest"]

Grok Build

grok mcp add quasar -- npx -y --fetch-retries=0 @quasar/mcp@latest

这会把服务器写入 ~/.grok/config.toml;加上 --scope project 则改为在项目中写入 .grok/config.toml。该配置段与 Codex 的形状相同:

[mcp_servers.quasar]
command = "npx"
args = ["-y", "--fetch-retries=0", "@quasar/mcp@latest"]

Grok Build 也会读取为 Claude Code 编写的项目 .mcp.json,因此一个文件可同时服务两者。

Cursor、Windsurf、VS Code 及其他

把上面的 JSON 放进客户端的 MCP 配置文件(.cursor/mcp.json、.windsurf/mcp.json、.vscode/mcp.json——后者用 servers 键代替 mcpServers,等等)。每个 MCP 客户端都会说明该文件的位置。

对于 VS Code(agent 模式下的 GitHub Copilot,以及支持 MCP 的扩展),配置 VS Code 页面提供了可直接复制的文件。用 Quasar CLI 脚手架生成的项目已经附带它。

助手能得到什么

工具用途
list_pages所有可离线获取的文档页面,按包分组
search_docs匹配某些关键词的页面、它们的大小以及关键词出现的章节
get_page一个页面、它的某一章节(按标题或链接 #anchor),或它的大纲
list_apiAPI 描述符的名称(QBtn、Notify、Ripple 等)
get_api其中某一项的 props、slots、events 和 methods,或其中的某一部分或成员
check_updatesquasar、@quasar/app-vite 或该服务器是否有更新版本

会话开始时,服务器会告知助手它服务的是哪些版本以及是否有可用更新,这样助手就能建议升级。该检查最多每天一次在后台运行(与 Quasar CLI 自己的更新提示一样),离线时绝不运行,并且遵循 NO_UPDATE_NOTIFIER 环境变量。

TIP

对于运行在早于内置文档的发布版上的项目,仍可通过 get_api 获得 API,但没有页面:服务器会给出需要升级的包名。