@symbo.ls/mcp 1.0.0

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.
Files changed (35) hide show
  1. package/.env.example +16 -0
  2. package/.env.railway +13 -0
  3. package/LICENSE +21 -0
  4. package/README.md +184 -0
  5. package/mcp.json +57 -0
  6. package/package.json +20 -0
  7. package/pyproject.toml +25 -0
  8. package/railway.toml +26 -0
  9. package/run.sh +17 -0
  10. package/symbols_mcp/__init__.py +1 -0
  11. package/symbols_mcp/server.py +1114 -0
  12. package/symbols_mcp/skills/ACCESSIBILITY.md +471 -0
  13. package/symbols_mcp/skills/ACCESSIBILITY_AUDITORY.md +70 -0
  14. package/symbols_mcp/skills/AGENT_INSTRUCTIONS.md +257 -0
  15. package/symbols_mcp/skills/BRAND_INDENTITY.md +69 -0
  16. package/symbols_mcp/skills/BUILT_IN_COMPONENTS.md +304 -0
  17. package/symbols_mcp/skills/CLAUDE.md +2158 -0
  18. package/symbols_mcp/skills/CLI_QUICK_START.md +205 -0
  19. package/symbols_mcp/skills/DESIGN_CRITIQUE.md +64 -0
  20. package/symbols_mcp/skills/DESIGN_DIRECTION.md +320 -0
  21. package/symbols_mcp/skills/DESIGN_SYSTEM_ARCHITECT.md +64 -0
  22. package/symbols_mcp/skills/DESIGN_SYSTEM_CONFIG.md +487 -0
  23. package/symbols_mcp/skills/DESIGN_SYSTEM_IN_PROPS.md +136 -0
  24. package/symbols_mcp/skills/DESIGN_TO_CODE.md +64 -0
  25. package/symbols_mcp/skills/DESIGN_TREND.md +50 -0
  26. package/symbols_mcp/skills/DOMQL_v2-v3_MIGRATION.md +236 -0
  27. package/symbols_mcp/skills/FIGMA_MATCHING.md +63 -0
  28. package/symbols_mcp/skills/GARY_TAN.md +80 -0
  29. package/symbols_mcp/skills/MARKETING_ASSETS.md +66 -0
  30. package/symbols_mcp/skills/MIGRATE_TO_SYMBOLS.md +614 -0
  31. package/symbols_mcp/skills/QUICKSTART.md +79 -0
  32. package/symbols_mcp/skills/SYMBOLS_LOCAL_INSTRUCTIONS.md +1405 -0
  33. package/symbols_mcp/skills/THE_PRESENTATION.md +69 -0
  34. package/symbols_mcp/skills/UI_UX_PATTERNS.md +68 -0
  35. package/windsurf-mcp-config.json +18 -0
@@ -0,0 +1,205 @@
1
+ ## `smbls` CLI Quick Start (practical starter guide)
2
+
3
+ This guide matches the CLI commands implemented in `packages/cli/bin/*`.
4
+
5
+ ### What you’ll get
6
+
7
+ - **A local starter project** (DOMQL) cloned from an official starter repo.
8
+ - **A working dev server** you can run with `npm start` (or `yarn start`).
9
+ - **Optional platform linking** so you can sync, collaborate, and manage project files with the Symbols platform.
10
+
11
+ ---
12
+
13
+ ## Install the CLI
14
+
15
+ Install globally:
16
+
17
+ ```bash
18
+ npm i -g @symbo.ls/cli
19
+ smbls --help
20
+ ```
21
+
22
+ ---
23
+
24
+ ## Recommended flow: `smbls project create` → `npm start`
25
+
26
+ ### 1) Create a new project locally (fastest path)
27
+
28
+ This creates a starter project and writes/updates `symbols.json` in the project root.
29
+
30
+ ```bash
31
+ smbls project create my-app --local-only
32
+ cd my-app
33
+ npm start
34
+ ```
35
+
36
+ ### After `npm start`: what to do next
37
+
38
+ - **Open the URL printed in your terminal** (the starter kit will tell you where it’s running).
39
+ - **Follow the starter page + project README** for “what to edit first” and recommended structure.
40
+ - **Develop with AI in your editor**: keep changes small, run the app, iterate quickly.
41
+
42
+ ### 2) Pick your framework template
43
+
44
+ Currently the CLI scaffolding supports **DOMQL only**.
45
+
46
+ ```bash
47
+ # DOMQL starter
48
+ smbls project create my-app --local-only --domql
49
+ ```
50
+
51
+ ### 3) Choose a package manager
52
+
53
+ ```bash
54
+ smbls project create my-app --local-only --package-manager npm
55
+ # or
56
+ smbls project create my-app --local-only --package-manager yarn
57
+ ```
58
+
59
+ ### 4) Skip dependency install (optional)
60
+
61
+ ```bash
62
+ smbls project create my-app --local-only --no-dependencies
63
+ cd my-app
64
+ npm i
65
+ npm start
66
+ ```
67
+
68
+ ---
69
+
70
+ ## Platform + community flow (optional, but unlocks collaboration)
71
+
72
+ If you want the “Symbols platform” benefits (project page/canvas, sharing, collaboration, etc.), link your local folder to a platform project.
73
+
74
+ ### 1) Sign in
75
+
76
+ ```bash
77
+ smbls login
78
+ ```
79
+
80
+ If you have multiple environments/servers configured, you can list/switch them:
81
+
82
+ ```bash
83
+ smbls servers
84
+ smbls servers --select
85
+ ```
86
+
87
+ ### 2) Create + link a new platform project (interactive)
88
+
89
+ This creates the platform project, creates the local starter project, then links them.
90
+
91
+ ```bash
92
+ smbls project create my-app --create-new
93
+ ```
94
+
95
+ What gets written locally:
96
+
97
+ - **`symbols.json`**: keeps the project key (legacy config used by multiple commands)
98
+ - **`.symbols/config.json`**: stores the platform link (`projectKey`, `projectId`, `apiBaseUrl`, `branch`)
99
+
100
+ ### 3) Link an existing platform project to this folder
101
+
102
+ Interactive picker:
103
+
104
+ ```bash
105
+ smbls project link .
106
+ ```
107
+
108
+ Or non-interactive:
109
+
110
+ ```bash
111
+ smbls project link . --key your-project.symbo.ls
112
+ # or
113
+ smbls project link . --id <projectId>
114
+ ```
115
+
116
+ ---
117
+
118
+ ## The core “sync” commands you’ll use day-to-day
119
+
120
+ ### Fetch the latest platform project into files
121
+
122
+ `fetch` downloads the latest project snapshot and can generate/update files under a `distDir`.
123
+
124
+ ```bash
125
+ smbls fetch --update
126
+ ```
127
+
128
+ Notes:
129
+
130
+ - **Default output directory** (if you don’t set one) is `./smbls`.
131
+ - You can set it once via:
132
+
133
+ ```bash
134
+ smbls config --dist-dir ./smbls
135
+ ```
136
+
137
+ ### Push local changes to the platform
138
+
139
+ Use this when you’ve edited locally and want to publish your changes upstream.
140
+
141
+ ```bash
142
+ smbls push
143
+ ```
144
+
145
+ ### Sync (two-way) with conflict handling
146
+
147
+ Use this when both local and remote changed and you want an interactive merge flow.
148
+
149
+ ```bash
150
+ smbls sync
151
+ ```
152
+
153
+ ### Collaborate (watch + live syncing)
154
+
155
+ Run in a separate terminal while you work to enable a collaboration workflow (watching local changes and syncing).
156
+
157
+ ```bash
158
+ smbls collab
159
+ ```
160
+
161
+ ---
162
+
163
+ ## File assets (uploads/downloads) linked to a project
164
+
165
+ These commands manage the project `files` map (upload, download, list, remove).
166
+
167
+ ```bash
168
+ smbls files list
169
+ smbls files upload
170
+ smbls files download
171
+ smbls files rm
172
+ ```
173
+
174
+ ---
175
+
176
+ ## If something fails: quick fixes
177
+
178
+ - **Auth required / access denied**: run `smbls login` again.
179
+ - **Missing project key**: ensure `symbols.json` has a `key` or link the folder via `smbls project link .`.
180
+ - **Need more detail**: add `--verbose` where supported (for example on `project create`).
181
+
182
+ ---
183
+
184
+ ## Alternative: `smbls create` (simple scaffolding)
185
+
186
+ If you only want the starter project and don’t care about platform linking yet:
187
+
188
+ ```bash
189
+ smbls create my-app
190
+ cd my-app
191
+ npm start
192
+ ```
193
+
194
+ ---
195
+
196
+ ## Suggested “team” defaults (optional)
197
+
198
+ - **Commit `symbols.json`**: it’s the minimal project identity/config used by the CLI.
199
+ - **Decide on committing `.symbols/config.json`**: it contains the project link (`projectId`, `projectKey`, `apiBaseUrl`, `branch`). Some teams commit it for consistency; others treat it as local-only.
200
+
201
+ ---
202
+
203
+ ## Symbols Feedback Conventions
204
+
205
+ Supplemental conventions are merged into [CLAUDE.md](CLAUDE.md).
@@ -0,0 +1,64 @@
1
+ The Design Critique Partner
2
+
3
+ You are a Design Director at Apple reviewing work from your team.
4
+
5
+ Perform a comprehensive design critique of the following:
6
+
7
+ [DESIGN DESCRIPTION, WIREFRAME, OR UPLOADED DESIGN]
8
+
9
+ Critique framework (be thorough but constructive):
10
+
11
+ 1. HEURISTIC EVALUATION
12
+ Evaluate against Nielsen's 10 heuristics:
13
+ □ Visibility of system status
14
+ □ Match between system and real world
15
+ □ User control and freedom
16
+ □ Consistency and standards
17
+ □ Error prevention
18
+ □ Recognition rather than recall
19
+ □ Flexibility and efficiency of use
20
+ □ Aesthetic and minimalist design
21
+ □ Help users recognize, diagnose, and recover from errors
22
+ □ Help and documentation
23
+
24
+ Score each 1-5 and provide specific examples.
25
+
26
+ 2. VISUAL HIERARCHY ANALYSIS
27
+ • What's the first thing users see? (Is it correct?)
28
+ • What's the call-to-action hierarchy?
29
+ • Are visual weights balanced?
30
+ • Is there adequate white space?
31
+
32
+ 3. TYPOGRAPHY AUDIT
33
+ • Font choices appropriate for brand?
34
+ • Type scale creates clear hierarchy?
35
+ • Line lengths optimal (45-75 characters)?
36
+ • Contrast sufficient for readability?
37
+
38
+ 4. COLOR ANALYSIS
39
+ • Palette supports brand personality?
40
+ • Sufficient contrast for accessibility (WCAG AA)?
41
+ • Color used meaningfully (not just decoratively)?
42
+ • Dark mode considerations?
43
+
44
+ 5. USABILITY CONCERNS
45
+ • Cognitive load assessment (too much information?)
46
+ • Interaction clarity (do users know what's clickable?)
47
+ • Mobile touch targets (minimum 44×44pt?)
48
+ • Form usability (label placement, validation)
49
+
50
+ 6. STRATEGIC ALIGNMENT
51
+ • Does this serve business goals?
52
+ • Does it serve user goals?
53
+ • Is the value proposition clear?
54
+ • Would this differentiate from competitors?
55
+
56
+ 7. PRIORITIZED RECOMMENDATIONS
57
+ • Critical (must fix before launch): [LIST]
58
+ • Important (fix in next iteration): [LIST]
59
+ • Polish (nice to have): [LIST]
60
+
61
+ 8. REDESIGN DIRECTION
62
+ Provide 2 alternative approaches with sketches described in words.
63
+
64
+ Tone: Constructive, educational, actionable. This is a teaching moment.
@@ -0,0 +1,320 @@
1
+ # AI Agent Context — Modern UI / UX Direction
2
+
3
+ ## Objective
4
+
5
+ Generate visually striking, contemporary interfaces that demonstrate clarity, authority, and perceptual refinement. Output must optimize cognitive flow, aesthetic coherence, and interaction intuitiveness without introducing system implementation assumptions or design-system mechanics.
6
+
7
+ This context governs visual direction, composition behavior, and user-experience reasoning only.
8
+
9
+ ---
10
+
11
+ ## Core Perceptual Goals
12
+
13
+ ### 1 — Immediate Comprehension
14
+
15
+ Interfaces must communicate structure and purpose within seconds.
16
+
17
+ - Primary action obvious without search
18
+ - Information hierarchy visually evident
19
+ - Navigation intent inferable without labels
20
+ - No visual noise competing with task completion
21
+
22
+ ---
23
+
24
+ ### 2 — Cognitive Load Minimization
25
+
26
+ Design reduces interpretation effort.
27
+
28
+ - Avoid dense clustering of elements
29
+ - Use whitespace to segment meaning
30
+ - Present progressive disclosure of complexity
31
+ - Prioritize recognition over recall
32
+
33
+ ---
34
+
35
+ ### 3 — Visual Authority
36
+
37
+ UI must appear deliberate and engineered.
38
+
39
+ - Balanced composition
40
+ - Confident typographic scale
41
+ - Stable alignment
42
+ - Clear focal anchors
43
+
44
+ Avoid:
45
+
46
+ - Arbitrary decoration
47
+ - Trend imitation without structural value
48
+ - Visual gimmicks
49
+
50
+ ---
51
+
52
+ ### 4 — Emotional Tone
53
+
54
+ Target tone:
55
+
56
+ - Precise
57
+ - Calm
58
+ - Intelligent
59
+ - Contemporary
60
+
61
+ Avoid:
62
+
63
+ - Playfulness unless product-specific
64
+ - Excessive personality signaling
65
+ - Novelty-first visual choices
66
+
67
+ ---
68
+
69
+ ## Visual Direction Framework
70
+
71
+ ### Composition Strategy
72
+
73
+ Construct layouts around focal gravity.
74
+
75
+ - Define primary visual center
76
+ - Arrange secondary elements in orbit
77
+ - Maintain directional eye flow
78
+ - Avoid visual dead zones
79
+
80
+ Preferred flows:
81
+
82
+ - Top-down scanning
83
+ - Z-pattern
84
+ - Layered depth grouping
85
+
86
+ ---
87
+
88
+ ### Spatial Relationships
89
+
90
+ Spacing conveys meaning.
91
+
92
+ - Proximity indicates relation
93
+ - Separation indicates conceptual boundary
94
+ - Density signals priority
95
+ - Openness signals optionality
96
+
97
+ Never treat spacing as decoration.
98
+
99
+ ---
100
+
101
+ ### Hierarchy Signaling
102
+
103
+ Hierarchy must be perceivable without reading text.
104
+
105
+ Use:
106
+
107
+ - Size contrast
108
+ - Weight contrast
109
+ - Positional prominence
110
+ - Color emphasis
111
+ - Depth layering
112
+
113
+ Avoid relying solely on color changes.
114
+
115
+ ---
116
+
117
+ ### Depth & Layering
118
+
119
+ Depth creates structural understanding.
120
+
121
+ Modern approaches:
122
+
123
+ - Soft elevation separation
124
+ - Subtle translucency
125
+ - Foreground isolation
126
+ - Background de-emphasis
127
+
128
+ Avoid:
129
+
130
+ - Overlapping without hierarchy
131
+ - Excessive blur
132
+ - Artificial skeuomorphism
133
+
134
+ ---
135
+
136
+ ### Color Usage Philosophy
137
+
138
+ Color directs attention and emotional framing.
139
+
140
+ - Use restrained palettes
141
+ - Reserve high saturation for action or importance
142
+ - Maintain visual stability across screens
143
+ - Prevent color dominance conflicts
144
+
145
+ Avoid:
146
+
147
+ - Rainbow distribution
148
+ - Decorative gradients everywhere
149
+ - Competing accent colors
150
+
151
+ ---
152
+
153
+ ### Typography Expression
154
+
155
+ Typography establishes personality and clarity.
156
+
157
+ - Confident scale transitions
158
+ - Consistent rhythm
159
+ - Strong headline anchoring
160
+ - Comfortable reading density
161
+
162
+ Avoid:
163
+
164
+ - Typography treated as ornament
165
+ - Excessive weight variation
166
+ - Alignment inconsistency
167
+
168
+ ---
169
+
170
+ ## Interaction Direction
171
+
172
+ ### Behavioral Clarity
173
+
174
+ Every interactive element must visually indicate affordance.
175
+
176
+ - Clickable looks actionable
177
+ - Draggable looks movable
178
+ - Expandable looks expandable
179
+
180
+ Ambiguity prohibited.
181
+
182
+ ---
183
+
184
+ ### Feedback Philosophy
185
+
186
+ System responses must feel immediate and informative.
187
+
188
+ - State changes visible
189
+ - Action confirmation perceptible
190
+ - Errors recoverable
191
+ - Progress perceivable
192
+
193
+ Avoid silent transitions.
194
+
195
+ ---
196
+
197
+ ### Motion Character
198
+
199
+ Motion exists to communicate state or continuity.
200
+
201
+ Appropriate uses:
202
+
203
+ - Focus guidance
204
+ - Structural transition
205
+ - Causality explanation
206
+
207
+ Avoid:
208
+
209
+ - Decorative animation
210
+ - Distracting motion
211
+ - Excessive choreography
212
+
213
+ ---
214
+
215
+ ### Navigation Experience
216
+
217
+ Navigation should create spatial orientation.
218
+
219
+ - Predictable structure
220
+ - Clear location awareness
221
+ - Easy return paths
222
+ - Minimal disorientation
223
+
224
+ Avoid:
225
+
226
+ - Hidden hierarchy
227
+ - Mode confusion
228
+ - Unexpected context shifts
229
+
230
+ ---
231
+
232
+ ## Responsiveness Experience Direction
233
+
234
+ Design must preserve intent across environments.
235
+
236
+ - Maintain hierarchy integrity
237
+ - Preserve interaction accessibility
238
+ - Ensure readability
239
+ - Keep actions discoverable
240
+
241
+ Avoid:
242
+
243
+ - Content collapse hiding key functions
244
+ - Layout fragmentation
245
+ - Interaction shrinking
246
+
247
+ ---
248
+
249
+ ## Accessibility as UX Quality
250
+
251
+ Accessibility treated as experience optimization.
252
+
253
+ - Perceptual clarity
254
+ - Motor accessibility
255
+ - Cognitive simplicity
256
+ - Readable contrast
257
+ - Focus visibility
258
+
259
+ Avoid treating accessibility as compliance-only.
260
+
261
+ ---
262
+
263
+ ## Error States & Empty States
264
+
265
+ ### Empty States
266
+
267
+ - Provide direction
268
+ - Reduce uncertainty
269
+ - Encourage next action
270
+
271
+ ### Error States
272
+
273
+ - Explain clearly
274
+ - Enable recovery
275
+ - Avoid alarm tone
276
+
277
+ These states influence perceived maturity of the product.
278
+
279
+ ---
280
+
281
+ ## Visual Sophistication Indicators
282
+
283
+ Generated UI should exhibit:
284
+
285
+ - Intentional restraint
286
+ - Structural balance
287
+ - Clear priority signaling
288
+ - Confident negative space
289
+ - Subtle depth orchestration
290
+ - Measured color emphasis
291
+ - Typographic authority
292
+
293
+ ---
294
+
295
+ ## Common Model Mistakes to Prevent
296
+
297
+ - Overcrowding layouts
298
+ - Symmetry overuse
299
+ - Center-alignment dominance
300
+ - Excess shadow stacking
301
+ - Trend dumping (multiple stylistic trends combined indiscriminately)
302
+ - Decorative icons without meaning
303
+ - Excess panels/cards
304
+ - Inconsistent focal anchors
305
+ - Emotional overstimulation
306
+ - Visual indecision
307
+
308
+ ---
309
+
310
+ ## Expected Outcome Characteristics
311
+
312
+ UI must demonstrate:
313
+
314
+ - Immediate usability
315
+ - Visual precision
316
+ - Perceptual stability
317
+ - Navigational predictability
318
+ - Controlled expressiveness
319
+ - Cohesive modern identity
320
+ - Experience confidence
@@ -0,0 +1,64 @@
1
+ The Design System Architect
2
+
3
+ You are a Principal Designer at Apple, responsible for the Human Interface Guidelines.
4
+
5
+ Create a comprehensive design system for [BRAND/PRODUCT NAME].
6
+
7
+ Brand attributes:
8
+
9
+ - Personality: [MINIMALIST/BOLD/PLAYFUL/PROFESSIONAL/LUXURY]
10
+ - Primary emotion: [TRUST/EXCITEMENT/CALM/URGENCY]
11
+ - Target audience: [DEMOGRAPHICS]
12
+
13
+ Deliverables following Apple HIG principles:
14
+
15
+ 1. FOUNDATIONS
16
+ • Color system:
17
+ - Primary palette (6 colors with hex, RGB, HSL, accessibility ratings)
18
+ - Semantic colors (success, warning, error, info)
19
+ - Dark mode equivalents with contrast ratios
20
+ - Color usage rules (what each color means and when to use it)
21
+
22
+ • Typography:
23
+ - Primary font family with 9 weights (Display, Headline, Title, Body, Callout, Subheadline, Footnote, Caption)
24
+ - Type scale with exact sizes, line heights, letter spacing for desktop/tablet/mobile
25
+ - Font pairing strategy
26
+ - Accessibility: Minimum sizes for legibility
27
+
28
+ • Layout grid:
29
+ - 12-column responsive grid (desktop: 1440px, tablet: 768px, mobile: 375px)
30
+ - Gutter and margin specifications
31
+ - Breakpoint definitions
32
+ - Safe areas for notched devices
33
+
34
+ • Spacing system:
35
+ - Usage guidelines for each scale step
36
+
37
+ 2. COMPONENTS (Design 30+ components with variants)
38
+ • Navigation: Header, Tab bar, Sidebar, Breadcrumbs
39
+ • Input: Buttons (6 variants), Text fields, Dropdowns, Toggles, Checkboxes, Radio buttons, Sliders
40
+ • Feedback: Alerts, Toasts, Modals, Progress indicators, Skeleton screens
41
+ • Data display: Cards, Tables, Lists, Stats, Charts
42
+ • Media: Image containers, Video players, Avatars
43
+
44
+ For each component:
45
+ - Anatomy breakdown (parts and their names)
46
+ - All states (default, hover, active, disabled, loading, error)
47
+ - Usage guidelines (when to use, when NOT to use)
48
+ - Accessibility requirements (ARIA labels, keyboard navigation, focus states)
49
+ - Code-ready specifications (padding, margins, border-radius, shadows)
50
+
51
+ 3. PATTERNS
52
+ • Page templates: Landing page, Dashboard, Settings, Profile, Checkout
53
+ • User flows: Onboarding, Authentication, Search, Filtering, Empty states
54
+ • Feedback patterns: Success, Error, Loading, Empty
55
+
56
+ 4. TOKENS
57
+ • Complete design token structure the following Symbols instructions
58
+
59
+ 5. DOCUMENTATION
60
+ • Design principles (3 core principles with examples)
61
+ • Do's and Don'ts (10 examples with visual descriptions)
62
+ • Implementation guide for developers
63
+
64
+ Format as a design system documentation that could be published immediately.