Gravityui Reference MCP

重力参考mcp

MCP（模型上下文协议）服务器提供AI优化的访问 重力UI 设计系统——34个库、1351个实体、19个食谱。包括预先摄入的数据，因此服务器可以脱机工作，无需进行其他设置 pnpm install.

工具

服务器公开了3个工具：

找到 --按意图搜索所有实体类型。用通俗易懂的语言描述你需要什么。

• query （必填）--例如“日期选择器”、“侧边栏导航”、“吐司通知”
• type （可选）--按实体类型筛选：“组件”、“钩子”、“实用程序”、“资产”、“令牌集”、“配置文档”、“指南”

得到 --深入了解一个实体、配方或系统概述。

• name （必填）——实体名称（“按钮”）、配方id（“确认对话框”）或“概述”
• detail （可选）--“紧凑”（默认）或“满”

列表 --使用正交过滤器浏览实体。

• type （可选）--“组件”、“钩子”、“实用程序”、“资产”、“配置文档”、“指南”、“令牌集”
• category （可选）--“动作”、“人工智能”、“数据显示”、“反馈”、“表单”、“布局”、“导航”、“叠加”、“排版”、“实用程序”
• library （可选）--例如“uikit”、“aikit”、”navigation”

设置

pnpm install

用法

本地设置

1. 克隆并安装：

   git clone https://github.com/antonskiter/gravityui-reference-mcp.git
   cd gravityui-reference-mcp
   pnpm install

1. 验证服务器是否启动：

   pnpm serve

按 Ctrl+C 停止。服务器通过stdio进行通信。

使用克劳德代码

全球注册：

claude mcp add gravityui-docs -s user -- npx tsx /absolute/path/to/gravityui-reference-mcp/src/server/server.ts

或每个项目：

claude mcp add gravityui-docs -- npx tsx /absolute/path/to/gravityui-reference-mcp/src/server/server.ts

验证：

claude mcp list
# gravityui-docs: ... - Connected

使用绝对路径 src/server/server.ts.

带光标

创建 .cursor/mcp.json 在项目根目录中（或 ~/.cursor/mcp.json 全球）：

{
  "mcpServers": {
    "gravityui-docs": {
      "command": "npx",
      "args": ["tsx", "/absolute/path/to/gravityui-reference-mcp/src/server/server.ts"]
    }
  }
}

重新启动游标或从“设置”>“MCP”重新加载MCP服务器。

试试看

问你的AI助手：

我需要一个预订表格的日期范围选择器

它将使用 find 要发现DatePicker，则 get 检索道具和示例。

数据管道

从供应商子模块更新数据的三步流程：

pnpm run update-submodules   # pull latest vendor/ sources
pnpm run extract             # per-library LLM extraction -> data/entities/*.json
pnpm run overview            # ecosystem overview + categories -> data/overview.json
pnpm run validate            # Zod schema + cross-reference checks

数据模型

生态系统中所有面向公众的事物都是 实体 使用统一的模式：

• 组件 --带有props、examples、import语句的React组件
• 钩子 --带有签名、参数和返回类型的React钩子
• 效用 --函数、类、常量
• 资产 --图标和插图
• 令牌集 --设计标记（间距、断点）
• 配置文档 --共享配置（eslint、tsconfig、更漂亮）
• 指南 --概念文档（i18n-react，nodekit概述）

加 食谱 --手工维护的UI模式（确认对话框、仪表板布局、表单验证等）。

脚本

• pnpm serve --启动MCP服务器（stdio，dev模式）
• pnpm build --编译TypeScript
• pnpm test --运行测试（Vitest）
• pnpm test:watch --观看模式
• pnpm run extract --每个库LLM实体提取
• pnpm run overview --生成生态系统概述
• pnpm run validate --使用Zod模式验证数据
• pnpm run update-submodules --更新供应商git子模块

许可证

MIT。文档 data/ 来源于 重力UI 存储库（MIT许可）。