@atomixstudio/mcp 1.0.8 → 1.0.10

package/README.md

@@ -146,6 +146,43 @@ Once connected, AI tools can use these:
 | `getAIToolRules(tool)` | Generate AI coding rules for your design system |
 | `exportMCPConfig(tool)` | Get MCP configuration for different tools |
 | `getSetupInstructions(tool)` | Get detailed setup guide |
+| `getDependencies(platform?, stack?)` | Get suggested dependencies (icons, fonts, SKILL.md, MCP config, tokens). Optional: `platform` (web, ios, android), `stack` (e.g. react, vue, next). Use with **atomix/install**. |
+
+### getDependencies
+
+Returns DS-derived suggestions so the client's AI can build a "Suggested" vs "Already present" list and, after user approval, install or copy assets.
+
+**Parameters (optional):**
+
+| Parameter | Description |
+|-----------|-------------|
+| `platform` | `web`, `ios`, or `android` |
+| `stack` | e.g. `react`, `vue`, `next`, `swift`, `kotlin` |
+
+**Returns (JSON):**
+
+- **iconLibrary** — `package`, `nativePackage`, and a **performance hint:** use individual SVG imports for tree-shaking; avoid loading entire icon libraries or icon fonts.
+- **fonts** — Font family names from typography tokens + **performance hint:** implement self-hosted fonts and local `@font-face`; avoid external CDN links; use `font-display: swap`.
+- **skill** — `path` (e.g. `.cursor/skills/atomix-ds/SKILL.md`) and `content` (generic, platform-agnostic SKILL.md).
+- **mcpConfig** — Path and content for MCP configuration.
+- **tokenFiles** — e.g. `["tokens.css", "tokens.json"]` with short copy instructions.
+
+If the design system or MCP is not available (e.g. no `--ds-id`), the tool may fail; the client should tell the user to configure MCP with `--ds-id` and try again.
+
+## atomix/install
+
+The **install** prompt suggests dependencies for your design system so you can get up and running quickly. It does **not** install anything by default; the client's AI presents a list and asks before making changes.
+
+**Flow (phased instructions):**
+
+1. **Resolve platform and stack** — Infer from the project (e.g. `package.json`, `build.gradle`) or **ask the user** if the project gives no hint (e.g. blank repo). Do not assume web or any default.
+2. **Get suggested dependencies** — Call `getDependencies(platform, stack)`. If the call fails (e.g. MCP not connected or no ds-id), tell the user: "Atomix MCP is not connected or design system ID is missing. Configure MCP with --ds-id and try again."
+3. **Scan codebase and build suggestion list** — Scan for `package.json` (or equivalent), existing skill path, token files, font/icon usage. Build **Suggested dependencies** (from getDependencies minus what's present) and **Already present**. Do not install or copy anything in this phase.
+4. **Present list and ask before install** — Reply with "Suggested dependencies: …" and "Already present: …" and state: "Do not install or copy anything until you confirm. Would you like me to install or add these?" Only perform steps the user approves.
+5. **Optional: suggest global styles** — If the project has no global styles that use the design system tokens, ask verbatim: "Your project doesn't appear to have global styles that use the design system tokens (e.g. semantic typography scale or semantic color classes). Would you like me to suggest or generate a minimal set (e.g. typography scale + semantic utilities) so you can develop consistently with the DS?"
+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. Updated: .cursor/mcp.json. Copied: tokens.css.").
+
+**Single SKILL.md:** The install flow suggests adding a generic, coding-platform agnostic SKILL at `.cursor/skills/atomix-ds/SKILL.md`. It instructs the AI to call `getAIToolRules({ tool: "<tool>" })` where `<tool>` matches the current environment (cursor, windsurf, copilot, cline, continue, zed, generic).
 
 ## Token Categories
 
@@ -169,7 +206,7 @@ By default, `sync` also updates AI rules files based on which AI tools you use:
 | `.windsurfrules` | Windsurf |
 | `.clinerules` | Cline |
 | `.continuerules` | Continue |
-| `.github/copilot-instructions.md` | GitHub Copilot |
+| `.github/copilot-instructions.md` | Copilot |
 | `AI_GUIDELINES.md` | Generic |
 
 The rules include your design system's governance guidelines and token usage instructions.
@@ -205,14 +242,6 @@ npx heyatomix sync
 - [Atomix Studio](https://atomixstudio.eu)
 - [MCP Protocol](https://modelcontextprotocol.io)
 
-## Publishing (maintainers)
-
-This package bundles `@atomixstudio/sync-core` so a single publish works from npm. To republish:
-
-1. From repo root, build sync-core (needed for local types): `cd packages/atomix-sync-core && pnpm run build`
-2. From `packages/mcp-user`: `pnpm run build` then `npm publish --access public`
-3. Bump version in `package.json` before each new publish.
-
 ## License
 
 MIT