onsystem

io.github.dgesteves由 GitHub 账号 dgesteves 发布v0.12.1更新于 Oct 31, 2026

Catches palette colors, native elements and APIs your design system lacks in agent-written React.

已验证STDIO仅桌面开发者工具媒体与设计

概览

AI 生成的概览

把 React 项目的设计系统(组件、props、变体与 token)提供给编码助手,并检查它写出的 TSX/JSX 是否符合该系统。

可以做什么
  • 按意图列出和搜索设计系统组件,含描述、变体、子部件与导入方式
  • 读取单个组件的完整契约:props、默认值、cva 变体、所用 token、使用指南与示例
  • 列出设计 token 的解析值与暗色模式值,以及对应的 Tailwind 类或 CSS 变量
  • 检查 TSX/JSX 中的硬编码颜色、间距与圆角、本有组件却用原生元素、未知组件/props/变体,以及无可访问名称的图标按钮
适用场景
适合拥有 React 设计系统包(shadcn/ui 应用可零配置使用)的团队,尤其是编码助手总写出调色板颜色、任意像素值和系统里不存在的 props 或变体时。希望助手先查组件再写、写完再自检的场景。
运行要求
以本地 stdio 进程通过 npx 运行,需要 Node.js 20.19 或更高版本。它从源码、类型声明、样式表、DTCG 文件或 DESIGN.md 读取组件与 token,因此需在应用目录或 monorepo 根目录运行。无需 API 密钥或账号,搜索排序在本地完成。
安装前请注意
check_ui 只报告问题,仍需助手自行修改;README 称其自测样本中约 11% 为误报,多为硬编码颜色类。在 monorepo 中应传入文件路径,确保结果来自对应项目。从 shadcn registry 安装的代码属第三方,可能需要排除或单独检查。

安装

在 SourceWeft 中

  1. 打开 控制台中的 onsystem,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

onsystem

Keeps coding agents on your design system: catches palette colors, native elements and APIs your system lacks, at every edit and pull request, with the fix. Set it up once in your design-system package; every app in your monorepo gets it. Runs locally and works alongside @shadcn/lint.

Built for design-system and platform teams with a React design-system package; a shadcn/ui app is the zero-config demo. Formerly @dgesteves/design-system-mcp (what changed).

Using the GitHub Action? uses: dgesteves/onsystem@v0 checks the lines a pull request changed: see CI and baselines.

[CI] [npm] [MCP Registry] [Cursor Directory] [License: MIT]

[Install in Cursor] [Install in VS Code] [Claude Code plugin] [GitHub Action]

Also works with [Codex CLI] [Gemini CLI] [Antigravity] [Grok Build] [GitHub Copilot CLI] [Claude Desktop] [Windsurf] [JetBrains] [Zed]

Website and docs: onsystem.vercel.app, with a playground that checks your own code.

Feedback wanted: say where it breaks in the launch feedback thread, see what's next in the roadmap, or pick up a good first issue. If onsystem is useful to you, a star helps other people find it.

https://github.com/user-attachments/assets/900cc1fa-387c-4e76-a524-a818521dd1a0

On the website, an agent drafts a settings card, check_ui finds 11 problems with a fix each, and the agent applies them. Then a real Claude Code session with the plugin: Claude looks the components up before writing, and check_ui passes. Last, the benchmark.

The problem

Coding agents write UI from their training data, not from your design system. Ask for a settings card and you get bg-[#ef4444], p-[13px], a native <button>, variant="danger" on a Button that only has destructive, and <Card.Header> where the system exports CardHeader. On the demo draft above, tsc reports 3 of the 11 problems, and review catches the rest when someone has the time. Describing the design system to the agent helps; what holds is checking what it actually wrote, at the edit and at the pull request.

What it checks

onsystem reads your components, cva and tv variants, parts and tokens from source with the TypeScript compiler, and checks .tsx and .jsx against them. Every finding has a rule id, a location and the fix. Tokens come from your stylesheets, DTCG 2025.10 files or a DESIGN.md, and onsystem export writes them out as either.

RuleDefaultCatches
no-unknown-componenterrorComponents and parts that don't exist (<Card.Header>, typos)
no-unknown-properrorProps a component doesn't take (tone, isDisabled)
no-unknown-varianterrorValues outside a variant (variant="danger")
prefer-design-system-componenterrorNative elements the design system has a component for (<button> → <Button>)
no-hardcoded-colorerrorHex, rgb, hsl, oklch and Tailwind palette colors (bg-gray-100 → bg-muted)
icon-button-accessible-nameerrorIcon-only buttons without an accessible name
no-hardcoded-spacingwarnArbitrary padding, margin and gap (p-[13px] → p-3)
no-hardcoded-radiuswarnArbitrary radius (rounded-[7px] → rounded-sm)

How often it is wrong. The corpus job runs check on 12 public repositories pinned by commit (Documenso, Dub, Cal.com, midday, Flowise and others: 24 runs, 14,539 distinct findings), without their dependencies installed (the two MUI apps get MUI). A seeded random sample of 80 of those findings, stratified by rule, was labelled from the code alone: blind labels by an AI reviewer (Claude Opus 5.5), not by a person. 57 are right, 14 debatable and 9 false positives: 11.2% (95% Wilson interval 6.0-20.0%), about the same when weighted by each rule's share of all findings (11.0%). Most come from no-hardcoded-color (7 of 65 sampled). Counting values a project's own design system already uses as debatable, 6 of 80 are false positives (7.5%, 3.5-15.4%). The sample has each label with its reason, the labeller's notes and the script behind these numbers. Shipped code rarely invents components, props or variants, and without dependencies no-unknown-prop skips components whose props do not resolve: those three rules have 56 findings in the corpus, 55 of them in Flowise, an MUI app, and 3 in the sample, all right but too few for a rate of their own. The corpus's older labels, made by an AI reviewer who could see the finding and so not blind, fail the job when one of their true positives stops being reported or a fixed false positive comes back. Code installed from a shadcn registry, such as the chatbot's components/ai-elements, has no labels yet (Code from shadcn registries). The rules reference shows each rule on an example and how to suppress a finding.

Quickstart

Run it from the app's folder or from the monorepo root, with Node.js 20.19 or later:

sh
npx -y onsystem inspect   # what it found; --explain says whynpx -y onsystem check .   # the same check the agent and CI runnpx -y onsystem init      # write the config, and offer a baseline

At a monorepo root, inspect lists every app and design-system package, and check checks each file by its own project's design system. In a design-system package, init sets it up for every app that depends on it, with no config in the apps: as a workspace package, or installed from npm. Installed apps read the components from the sources the package publishes, or from its type declarations (.d.ts) when it publishes only compiled dist/, and get every rule either way (init checks its files list). From a package that publishes compiled code and no type declarations, they get the token rules but no component, prop, variant or native-element checks.

In a new create-next-app, the template page's hardcoded colors already make the first check . fail; init offers to record them as a baseline, so only new findings fail. Folders installed from a shadcn registry, such as components/ai-elements, are someone else's code: Code from shadcn registries says how to check them or leave them out.

Claude Code. The plugin brings the hook, the MCP server and a skill:

text
/plugin marketplace add dgesteves/onsystem/plugin install onsystem@dgesteves

After each Write or Edit of a .tsx or .jsx file, the hook runs onsystem check on it. Errors go back to Claude as a blocking error with the fix, so Claude corrects the file before it moves on; warnings go as a note. It stays quiet in projects without a design system. Codex installs the same plugin, and the hook checks the files its apply_patch changes. What it runs and touches.

Cursor or VS Code. [Install in Cursor] [Install in VS Code], or commit the config. The agent gets the tools and runs check_ui on what it writes.

Other agents. npx skills add dgesteves/onsystem adds the skill to any agent with Agent Skills, and there are plugins for Codex, GitHub Copilot CLI, VS Code and Cursor.

Any MCP client. Run npx -y onsystem as a stdio server. There are configs for Claude Desktop, Codex CLI, GitHub Copilot CLI, Windsurf, JetBrains IDEs, Zed, Gemini CLI, Antigravity and Grok Build.

CI. Install it as a dev dependency, accept the findings the codebase already has once, and fail pull requests only on new ones:

sh
npm install --save-dev onsystemnpx onsystem check . --update-baseline   # writes onsystem.baseline.json: commit it
yaml
- run: npx onsystem check . --format github --require-design-system

Findings show up as annotations on the pull request, and --require-design-system fails the job when the design system is no longer found. CI and baselines has the whole workflow.

GitHub Action. The action runs the same check, honours the baseline and annotates only the lines a pull request changed. It goes after the checkout and the install, so it can read your design system:

yaml
steps:  - uses: actions/checkout@v7  - uses: actions/setup-node@v7    with:      node-version: 24      cache: npm  - run: npm ci  - uses: dgesteves/onsystem@v0

Make it a required check on agent pull requests has the whole workflow and its inputs.

ESLint. The same rules for ESLint 8.57, 9 and 10: add onsystem.configs.recommended from onsystem/eslint to eslint.config.mjs (ESLint plugin, with @shadcn/lint).

Works with @shadcn/lint

@shadcn/lint checks the Tailwind classes written against a component and the theme (restyling, raw colors, arbitrary and unknown classes) as ESLint or Oxlint rules on Tailwind v4. onsystem checks that the components, props and variant values exist and flags native elements and unnamed icon buttons, on Tailwind v3 or v4. Its MCP server shows the agent your components and tokens before it writes, and in Claude Code its hook checks every edit. Run both. Benchmark v2 also scores every output with @shadcn/lint: see the independent scorer's table.

Does it help?

Benchmark v2 gave 6 models from 3 providers (Anthropic, OpenAI and Google) 20 single-file UI tasks in 5 open-source repositories, without onsystem, with its skill, MCP server or hook, and with all three: 1,200 runs, 240 per arm. Counted by onsystem 0.5.0's own check, design-system errors per run went from 0.85 without onsystem to 0.00 with all three, with no measurable change in the tsc pass rate (93% → 92%).

That count is onsystem's own, and the MCP server and the hook show the agent the same errors to fix. In tasks that ask for a green status label in a design system with no success token, agents with onsystem often used chart-* tokens, which it counts as clean. The blind labels by an AI reviewer, 12 files per arm, are too few to confirm the count either way, and every violation they found with the hook or all three is a palette color in Dub, whose tokens 0.5.0 did not read. The benchmark page has every table, and bench/v2 the method, the per-run data and every generated file.

Compatibility

What package.json declares and CI runs:

WithSupported
Node.jsNode.js 20.19 or later (engines). CI runs the tests on Node.js 22, 24 and 26, and the built package on 20.19
Operating systemLinux, macOS and Windows: CI runs the tests and the pack test on each
ESLintESLint 8.57, 9 and 10, for the ESLint plugin only: eslint is an optional peer, and the CLI, the MCP server, the hook and the Action do not need it
TypeScriptYour project's TypeScript is not used, and a JavaScript project needs none: onsystem reads .tsx and .jsx with its own TypeScript 6.0, a dependency, not a peer
ReactComponents written for React 18 (forwardRef) or React 19 (ref as a prop), read from source or type declarations. onsystem does not depend on React
Tailwind CSSv4 (@theme) and v3 (tailwind.config, read without running it). Without Tailwind, tokens come from CSS custom properties, DTCG files or a DESIGN.md
shadcn/uiBoth bases, Radix (asChild) and Base UI (render), on Tailwind v3 or v4, with no config
MCP clientsAny client that starts a stdio server; CI connects on the 2025-11-25 and 2026-07-28 protocols. Set up your agent has each client's config and support tier

Docs

On the website, and as Markdown in docs/:

Contributing, security and the changelog are in the repository.

License

MIT © Diogo Esteves

来源:README.md,提交 3c74d21

工具

5

list_components

List design-system components

List every component in the project design system with a one-line description, the native element it renders, its variant values, its parts and its import. Icons (components that render an <svg>) are named on one line per import, or per folder for icons with a module each, five or more to a line. Call this before writing UI in this project. `query`, `kind` and `limit` narrow a long list. At a monorepo root, pass `path` for the project of the file you are editing; without it, every project is listed, each component with its package.

输入参数kindpathlimitquery

get_component

Get a component contract

Get the full contract of one component: import, props with types and defaults, cva variants and the classes each applies, parts (sub-components), design tokens it uses, usage guidelines and examples from its docs. Call it before using a component. Accepts "Button", "CardHeader" or "Card.Header". At a monorepo root, pass `path` (the file you are editing) to get the component its project uses.

输入参数name必填path

search_components

Search components by intent

Find components by what you want to build, e.g. "confirm a destructive action", "status label", "text field with validation". Ranks names, descriptions, docs, props and variant values with BM25 (local, no API key). When no component clearly matches, it says so and lists the nearest, marked `weak`. Use it when you do not know which component fits.

输入参数pathlimitquery必填

get_tokens

Get design tokens

List design tokens with resolved values, dark-mode values and how to use each (Tailwind class or CSS variable). Filter by category (color, spacing, radius, typography, shadow, other) or a substring. Use these instead of hex codes, px values or Tailwind default palette classes. Chart and sidebar colors are listed under their own headings: they are for charts and the sidebar, not for status colors.

输入参数pathquerycategory

check_ui

Check UI code against the design system

Lint TSX/JSX against the design system. Reports hardcoded colors, spacing and radius (with the nearest token), native elements that have a design-system component, unknown components, props and variant values, and icon-only buttons without an accessible name. Each diagnostic has line/column, a rule id, a message and a suggested fix. Run it on every snippet or file you write and fix all errors. Pass `path` for a file in the project, or `code` for unsaved code, with `path` (or `filename`) naming the file it is for or its project folder.

输入参数codepathlimitfilename

版本历史

9
  1. v0.12.1最新Oct 30, 2026
  2. v0.11.1Oct 29, 2026
  3. v0.10.0Oct 24, 2026
  4. v0.9.0Oct 21, 2026
  5. v0.8.0Oct 16, 2026
  6. v0.7.0Oct 16, 2026
  7. v0.6.0Oct 12, 2026
  8. v0.5.0Oct 11, 2026
  9. v0.4.0Oct 10, 2026

评分

已满足适用检查项的 90%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分
  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分