@atomixstudio/mcp 1.0.35 → 1.0.37
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -33
- package/dist/index.js +29 -854
- package/dist/index.js.map +1 -1
- package/package.json +3 -5
- package/dist/chunk-426RNS3G.js +0 -1782
- package/dist/chunk-426RNS3G.js.map +0 -1
- package/dist/figma-bridge-protocol.d.ts +0 -28
- package/dist/figma-bridge-protocol.js +0 -14
- package/dist/figma-bridge-protocol.js.map +0 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
MCP (Model Context Protocol) server and CLI for Atomix Design System. Query and sync design tokens from AI coding tools (Cursor, Claude Desktop, Windsurf, etc.) or from the command line.
|
|
4
4
|
|
|
5
|
-
**Version:** 1.0.
|
|
5
|
+
**Version:** 1.0.36 — MCP exposes token/query tools and **syncAll** (writes `.cursor/skills/atomix-ds/SKILL.md` and `atomix-dependencies.json`). Figma push/design-in-Figma are not part of this package; use Atomix Studio and the Figma plugin for in-Figma workflows.
|
|
6
6
|
|
|
7
7
|
## Getting Your Credentials
|
|
8
8
|
|
|
@@ -62,12 +62,11 @@ Once connected, the AI can call these tools:
|
|
|
62
62
|
| `listTokens(category)` | List all tokens in a category |
|
|
63
63
|
| `searchTokens(query)` | Search tokens by name or value |
|
|
64
64
|
| `validateUsage(value)` | Check if a hardcoded value should use a token |
|
|
65
|
-
| `syncAll(options?)` | Sync tokens, AI rules,
|
|
65
|
+
| `syncAll(options?)` | Sync tokens, AI rules, `.cursor/skills/atomix-ds/SKILL.md`, and atomix-dependencies.json. One tool for full project sync. **/--sync** invokes this. Optional: `workspaceRoot` (project root so files are written in the repo; else `ATOMIX_PROJECT_ROOT` env or cwd), `output` (default ./tokens.css), `format` (default css), `skipTokens` (if true, only skill + manifest). |
|
|
66
66
|
| `getRules(topic?)` | Get design system governance rules; optional topic: colors, typo, motion, icons, layout, visual |
|
|
67
67
|
| `exportMCPConfig(tool)` | Get MCP configuration for different tools |
|
|
68
68
|
| `getSetupInstructions(tool)` | Get detailed setup guide |
|
|
69
69
|
| `getDependencies(platform?, stack?)` | Get suggested dependencies (icons, fonts, SKILL.md, token files). Optional: `platform` (web, ios, android), `stack` (e.g. react, vue, next). Use with **/--get-started** prompt. |
|
|
70
|
-
| `syncToFigma()` | Push design system to Figma (variables, paint styles, text styles, effect styles). Uses built-in bridge + Atomix plugin. If the plugin is not connected, the response includes `agentInstruction` to connect. **Available on all tiers (Free and Pro).** |
|
|
71
70
|
|
|
72
71
|
### getDependencies
|
|
73
72
|
|
|
@@ -80,7 +79,6 @@ Returns DS-derived suggestions so the AI can build a "Suggested" vs "Already pre
|
|
|
80
79
|
- **iconLibrary** — `package`, `nativePackage`, and a performance hint (use individual imports; apply the DS icon sizing/weight token when rendering icons).
|
|
81
80
|
- **fonts** — Font family names from typography tokens + hint to link fonts via URL (e.g. Google Fonts); no need to download or add font files to the repo.
|
|
82
81
|
- **skill** — `path` (e.g. `.cursor/skills/atomix-ds/SKILL.md`) and `content` (generic, platform-agnostic SKILL.md).
|
|
83
|
-
- **skillFigmaDesign** — `path` (`.cursor/skills/atomix-ds/figma-design-SKILL.md`) and `content` (Figma design skill: advisory and generative UI on the Figma canvas).
|
|
84
82
|
- **tokenFiles** — e.g. `["tokens.css", "tokens.json"]` with copy instructions.
|
|
85
83
|
- **meta** — `dsName`, `platform`, `stack`, `designSystemVersion`, `designSystemExportedAt`. Use `designSystemVersion` to compare with skill frontmatter `atomixDsVersion` and suggest **syncAll** when the design system is newer.
|
|
86
84
|
|
|
@@ -88,7 +86,7 @@ If the design system is unavailable, the tool may fail; the client should tell t
|
|
|
88
86
|
|
|
89
87
|
### syncAll
|
|
90
88
|
|
|
91
|
-
**syncAll** is the single sync tool: tokens file, AI rules,
|
|
89
|
+
**syncAll** is the single sync tool: tokens file, AI rules, `.cursor/skills/atomix-ds/SKILL.md`, and **atomix-dependencies.json**. The manifest records icon library, font families, and the skill path. The **/--sync** prompt invokes it. All paths are resolved under a project root so files are written **inside the repo** (committable). Project root is: `workspaceRoot` argument → `ATOMIX_PROJECT_ROOT` env → `process.cwd()`. Optional: `workspaceRoot` (absolute path to repo root), `output` (default `./tokens.css`), `format` (default `css`), `skipTokens` (if true, only writes skills and manifest).
|
|
92
90
|
|
|
93
91
|
**Skill versioning:** Synced skills get frontmatter `atomixDsVersion` and `atomixDsExportedAt` (from the design system at sync time). The manifest’s `skills.syncedAtVersion` matches. The AI can compare the skill’s `atomixDsVersion` to **getDependencies**’ `meta.designSystemVersion`; if the design system is newer, it can suggest running **syncAll** to update.
|
|
94
92
|
|
|
@@ -98,13 +96,11 @@ Run these prompts from your AI tool (e.g. **/--hello**, **/--get-started**):
|
|
|
98
96
|
|
|
99
97
|
| Prompt | Description |
|
|
100
98
|
|--------|-------------|
|
|
101
|
-
| **/--hello** | Get started — overview, tokens, essential commands
|
|
99
|
+
| **/--hello** | Get started — overview, tokens, and essential commands. Run this first. |
|
|
102
100
|
| **/--get-started** | Get started with design system in project. Three phases; creates files only after you approve. |
|
|
103
101
|
| **/--rules** | Governance rules for your AI tool (Cursor, Copilot, Windsurf, etc.). |
|
|
104
102
|
| **/--sync** | Sync tokens, AI rules, skills files, and dependencies manifest (icons, fonts). Use **/--refactor** to migrate deprecated tokens. |
|
|
105
103
|
| **/--refactor** | Migrate deprecated tokens in codebase. Run after **/--sync**. |
|
|
106
|
-
| **/--sync-to-figma** | Push design system to Figma. Requires bridge + Atomix plugin; see [Sync to Figma](#sync-to-figma) below. **Available on all tiers (Free and Pro).** |
|
|
107
|
-
| **/--design-in-figma** | Load the Figma design skill and use the **designInFigma** MCP tool to design UI in the connected Figma file (catalog, query, execute). **Pro only.** |
|
|
108
104
|
|
|
109
105
|
## --get-started (get started)
|
|
110
106
|
|
|
@@ -119,31 +115,7 @@ The **/--get-started** prompt suggests dependencies for your design system so yo
|
|
|
119
115
|
5. **Optional: suggest global typeset** — If the project has no global styles that use the design system tokens, offer to build a full typeset (Display, Heading, body, caption) from the DS typography tokens via getToken/listTokens, including fontFamily, fontSize, fontWeight, lineHeight, letterSpacing—not just font imports.
|
|
120
116
|
6. **Report what was created** — After any install/copy steps, list what was created or updated (e.g. "Installed: lucide-react. Added: .cursor/skills/atomix-ds/SKILL.md. Synced: tokens.css.").
|
|
121
117
|
|
|
122
|
-
**
|
|
123
|
-
|
|
124
|
-
## Sync to Figma
|
|
125
|
-
|
|
126
|
-
**/--sync-to-figma** (or the **syncToFigma** tool) pushes your design system into the open Figma file: color variables, paint styles, number variables (spacing, radius, borders, sizing, breakpoints), text styles, and shadow effect styles. The **Figma bridge runs inside this MCP server** (no separate process). You only need the Atomix Figma plugin and "Connect to Cursor" (no Figma REST API or token).
|
|
127
|
-
|
|
128
|
-
**Tier:** Sync to Figma is available on **all tiers** (Free and Pro).
|
|
129
|
-
|
|
130
|
-
**Flow:**
|
|
131
|
-
|
|
132
|
-
1. **Plugin not connected?** The tool checks first. If the plugin is not connected, the response includes `bridgeNotRunning`, `agentInstruction`, and `userInstruction`. Ensure Cursor has this MCP server running, then in Figma run the Atomix plugin and click **Connect to Cursor**, then call **syncToFigma** again.
|
|
133
|
-
2. **Only if that fails** should the user check MCP configuration and plugin connection manually.
|
|
134
|
-
|
|
135
|
-
## Design in Figma
|
|
136
|
-
|
|
137
|
-
**/--design-in-figma** (or the **designInFigma** tool) loads the Figma design skill into context and directs the AI to use the designInFigma MCP tool to create or edit UI in the connected Figma file. The prompt injects the full Figma design skill content and instructs the agent to call designInFigma with `action: "catalog"` first, then `"query"` (e.g. get_selection, get_design_screenshot) or `"execute"` (design steps).
|
|
138
|
-
|
|
139
|
-
**Tier:** Design in Figma is **Pro only**. Free users do not see this prompt or the designInFigma tool in their MCP session.
|
|
140
|
-
|
|
141
|
-
**User steps (when needed):**
|
|
142
|
-
|
|
143
|
-
1. **Ensure MCP is running** — Cursor should have this MCP server configured and running (the bridge is built in; no separate bridge process).
|
|
144
|
-
2. **Install and run the Atomix plugin** — In Figma: Open Plugins and run the Atomix plugin (Atomix Token Extractor). If it's not installed yet, install it from the Figma Community or your team's plugin library, then run it.
|
|
145
|
-
3. **Connect** — In the plugin UI, tap **Connect to Cursor** and wait until the status shows "Connected".
|
|
146
|
-
4. Run **Sync to Figma** again.
|
|
118
|
+
**SKILL:** The get-started flow suggests `.cursor/skills/atomix-ds/SKILL.md` (generic, platform-agnostic; call `getRules` for governance rules). Run **/--sync** to write the skill via **syncAll**; .rules files (e.g. .cursorrules) are no longer written.
|
|
147
119
|
|
|
148
120
|
## Token Categories
|
|
149
121
|
|