Skip to main content

canpoint-ui-mcp

研学产品线的 UI 规范查询 MCP 服务。在 Claude Code / Cursor 等支持 MCP 的 AI 工具里接入后,AI 可以随时查询「研学小程序」与「研学后台」的官方设计规范, 按规范生成和自检页面,不再凭空发挥。

能帮你做什么

  • 查设计 token:色彩(主色/语义色/状态色/中性色阶)、字体字号阶梯、间距、 圆角、投影、布局密度,全部来自设计稿实测值
  • 查组件规格:侧边导航、表格、表单、弹窗、Tab、分页、状态标签、步骤条、 空态等组件的尺寸、颜色与状态变体
  • 按页面类型取模式卡:布局骨架精确几何(每个区域块的 x/y/w/h 坐标)、 组件组合、状态清单、新画页 checklist,直接按卡施工——admin 覆盖列表页/ 详情页/表单弹窗/数据看板等 9 类页面,mini 覆盖首页/课程列表/订单表单/ 我的页等 11 类页面
  • 拿生成纪律:生成页面前必须遵守的规则包(版本基准、断点事实、 设计稿未提供的状态清单等),避免虚构不存在的样式
  • 截图校验:把生成好的页面截图交给 verify_ui,逐色比对官方规范并给出 PASS/FAIL 结论,不达标精确到哪个颜色差多少

工具一览

工具 用途
list_platforms 列出可用平台(mini=研学小程序,admin=研学后台)与数据状态,建议会话开始先调用
get_tokens(platform, category) 按类别查 token:color / typography / spacing / shape / elevation / layout,category 留空返回全部
list_components(platform) 列出该平台全部组件规范条目
get_component_spec(platform, component) 查单个组件完整规格,支持中文名与模糊匹配(如"表格"→list)
get_generation_rules(platform) 生成 UI 前必读的纪律包
list_page_patterns(platform) 列出该平台全部页面模式卡摘要(id/中文名/适用场景/区域数/清单数),挑选目标页面类型
get_page_pattern(platform, page_type) 取单个页面模式完整卡:布局骨架精确几何、组件组合、token 用法、状态清单、版本变体与施工 checklist;page_type 支持模式 id、中文名与模糊匹配
verify_ui(platform, image_base64) 对生成页面截图做色彩校验,返回逐色偏差与 PASS/FAIL

前置条件

  1. 已安装 uv(提供 uvx 命令)
  2. 向服务管理员获取:服务地址 与 API key(usk_ 前缀,按人发放)

配置

两个环境变量必填:

变量 说明
UI_SPEC_SERVER_URL 服务地址(管理员提供,不带 /mcp 后缀)
UI_SPEC_API_KEY 管理员发放的 key

可选:UI_SPEC_TIMEOUT(超时秒数,默认 30)、UI_SPEC_LOG_LEVEL(默认 INFO)。

Claude Code(项目 .mcp.json 或全局配置):

{
  "mcpServers": {
    "canpoint-ui": {
      "command": "npx",
      "args": ["-y", "canpoint-ui-mcp"],
      "env": {
        "UI_SPEC_SERVER_URL": "<管理员提供的服务地址>",
        "UI_SPEC_API_KEY": "usk_<你的key>"
      }
    }
  }
}

Cursor:mcp.json 同款配置。

Windows 下若 npx 启动失败,把 command 改为 cmd、args 改为 ["/c", "npx", "-y", "canpoint-ui-mcp"](env 不变)。

不走 npm 也可以直接用:

UI_SPEC_SERVER_URL=<服务地址> UI_SPEC_API_KEY=usk_xxx uvx canpoint-ui-mcp

推荐用法(给接入方的 AI 提示词参考)

生成研学前端页面前:先 list_platforms 确认平台 → get_generation_rules 读纪律 → list_page_patterns 看有哪些页面模式 → get_page_pattern 取目标 页面模式卡 → get_tokens / get_component_spec 补齐规格 → 按模式卡的 skeleton 几何与 checklist 生成 → 截图交给 verify_ui 自检,FAIL 则按报告 修正后重验。

常见问题

现象 处理
提示「认证或授权失败」 key 错误/已吊销,联系管理员核对
提示「服务不可用」 服务地址填错或服务维护中,联系管理员
查询返回「规范数据未就绪」或「模式库未就绪」 该平台 DNA 或页面模式库维护中,稍后再试或联系管理员
某状态样式查不到 设计稿未提供,纪律包中有清单;不要虚构,找设计师确认

License

Apache-2.0

Metadata

Release files for canpoint-ui-mcp 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for canpoint-ui-mcp 0.2.0
File Interpreter ABI Platform Actions
canpoint_ui_mcp-0.2.0-py3-none-any.whl Python 3 none any Details for canpoint_ui_mcp-0.2.0-py3-none-any.whl

Release files / canpoint_ui_mcp-0.2.0-py3-none-any.whl

Download URL canpoint_ui_mcp-0.2.0-py3-none-any.whl
Size 20.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
147eb7a1d3dd4c73a78ef463cc87b5804b061bd663862853147742083389112a
BLAKE2b-256 checksum
How to use checksums
eb642edcddb5a4626612a36d5d28db82bc27754eb288a84ce5850365a328fe76
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for canpoint-ui-mcp 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page