MCP 服务器

BoardUI 附带了 MCP 服务器,因此 AI 智能体可以为您完成安装。 Claude Code、Cursor、VS Code、Codex 和任何 MCP 客户端都可以浏览注册表、读取组件源代码和实际使用示例、设置新项目并将组件文件直接写入其中。没有终端往返,您只需描述您想要构建的内容。

服务器通过 stdio 在本地运行 npx,没有托管任何内容。免费组件零配置工作;一旦您的智能体激活您的许可证密钥,BoardUI Pro 就会在同一聊天中解锁。

以下适用于每个客户端的一条规则:MCP 工具在会话开始时绑定。如果您在会话中注册服务器,请重新启动客户端或打开新的聊天,否则它将显示为已连接且没有可用工具。

设置

选择你的客户。光标和 VS Code 一键安装; Claude Code 和 Codex 采用同一个命令。

项目目录中的一条命令。添加 --scope user 为每个项目启用它,然后重新启动 Claude Code(或打开一个新会话)以便工具绑定。

claude mcp add boardui -- npx -y boardui@latest mcp

Monorepos 和自定义别名

本地MCP服务器读取相同的可选 boardui.json 作为 CLI。将其放在目的地包裹旁边 package.json 并将该包的绝对路径传递为 projectDir 到 init_boardui, install_components, 和 install_rules。文件和 npm 依赖项使用配置的导入别名安装到该包中。

一样通过 projectDir 到 get_component 和 get_usage_examples 用于匹配源和示例。如果没有它,这些读取工具将返回原始注册表导入。包导出和每个应用程序的样式仍然需要设置。

设置共享 UI 包

尝试询问你的智能体人

连接后,请用简单的语言与您的智能体交谈。一些入门者:

  • “在此项目中设置 BoardUI 并添加按钮、选择器和日期选择器。”
  • “我买了 BoardUI Pro。这是我的许可证密钥:XXXX。激活它并安装AI聊天模板。”
  • “使用 BoardUI 的身份验证卡和社交按钮构建登录页面。”
  • “在此 BoardUI 项目中启用阿拉伯语和希伯来语的 RTL,包括 Pro 块和模板。”
  • “BoardUI 按钮需要什么属性?显示图标变体。”
  • “添加 BoardUI 的数据表并将其连接到我的 /api/orders 端点。”
  • “向我展示 BoardUI 的主题变量,然后重新设计主按钮以匹配我的品牌。”
  • “使用 BoardUI 统计卡、面积图和条形列表构建收入仪表盘。”

工具

服务器向您的智能体公开的内容:

工具它的作用
get_startedOverview of BoardUI, the typical flow, RTL setup, and the Pro licensing rules.
list_componentsEvery installable item with exact names, free and Pro, grouped by type.
get_componentDescription, dependencies, usage example, and full source for one item.
get_usage_examplesWorking code snippets from the item's docs page, Pro items included.
install_componentsWrites component source into the project and installs missing npm deps.
init_boarduiOne-time setup: Tailwind v4, runtime deps, theme and global styles, utils.
install_rulesWrites the always-on design rules into AGENTS.md and .cursor/rules/.
get_skillExplains the agent skill: live SKILL.md, bundled files, install options per client.
install_skillInstalls the BoardUI agent skill (catalog, theming, patterns) into .claude/skills/.
get_themeThe theme tokens, type scale, global stylesheet, and RTL setup guidance.
activate_licenseActivates a BoardUI Pro license key on the machine and stores it.
license_statusWhether a Pro license is active, with the key shown masked.
deactivate_licenseReleases the machine's Pro seat and removes the stored key.

永远在线的设计规则

MCP 工具是按需提供的:智能体只有在想要询问时才会看到您的主题,而从不询问的模型会发明自己的间距、颜色和类型。所以 init_boardui (和 npx boardui init)还安装设计基础作为始终在线的指令文件,智能体加载每个会话: AGENTS.md 和游标规则 .cursor/rules/boardui.mdc。它们固定语义颜色变量、复合类型比例、间距和半径约定、深色模式以及 cx(),然后重新运行刷新该部分,而不触及文件的其余部分。

在此之前初始化您的项目?要求你的智能体运行 install_rules.

想要更深入的始终加载的知识,以及完整的目录、主题和页面模式吗?安装 BoardUI智能体技巧 与 MCP 一起(install_skill, 或 npx boardui skill).

基于 MCP 的 BoardUI Pro

Pro 组件和模板出现在 list_components 对于每个用户。如果没有许可证,您的智能体将获得描述、公共使用示例和购买说明,而不是源。购买 Pro 后,将购买电子邮件中的许可证密钥粘贴到聊天中;智能体激活它 activate_license (一个席位,随时释放 deactivate_license),从那时起,专业版项目的安装与免费项目完全相同。每次 Pro 下载时都会在服务器端验证密钥。

已经登录 boardui login? MCP 服务器使用相同的存储许可证,无需重做。

匿名遥测

成功安装会报告与 CLI 相同的匿名事件(组件名称、包管理器、版本),标记为 MCP 驱动。没有项目路径、提示或源代码。禁用与 BOARDUI_TELEMETRY_DISABLED=1 或 DO_NOT_TRACK=1 在服务器环境中。

使用shadcn的MCP代替

BoardUI 注册表使用 shadcn 架构,因此如果您的智能体已经运行 shadcn MCP 服务器,您可以通过它访问 BoardUI:将命名空间添加到 components.json 并要求 @boardui/button。上面的 BoardUI 服务器仍然是更丰富的路径,包含使用示例、项目设置和 Pro 许可。

{ "registries": { "@boardui": "https://www.boardui.com/r/{name}.json" }}

在引擎盖下

npx boardui@latest mcp 启动 CLI 使用的相同引擎,通过 stdio 讲 MCP。它从 boardui.com 获取公共注册表,传递性地解析组件依赖关系,并使用默认布局或您的布局写入文件。 boardui.json 映射。您还可以手动运行它来检查设置:

npx boardui@latest mcp