Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
28b94b2
Add new commands for Optics design system and update package.json
dallasbpeters Feb 5, 2026
b7d8247
Remove MCP Scaffolding Test Prompt file from the repository
dallasbpeters Feb 5, 2026
774c3d8
Fix test:interactive
dallasbpeters Feb 5, 2026
ce143cf
Remove .claude specific commands. After further research promps shoul…
dallasbpeters Feb 5, 2026
fa51cf7
Extract get token tool to its own file (#19)
Jeremy-Walton Feb 5, 2026
2af1668
Extract token usage stats (#20)
Jeremy-Walton Feb 5, 2026
50cd90b
Extract Search Tokens Tool (#21)
dominicmacaulay Feb 5, 2026
c8db486
Extract list components (#22)
Jeremy-Walton Feb 5, 2026
41601ab
Extract Get Component Info Tool (#23)
dominicmacaulay Feb 5, 2026
7d91eaf
Extract Get Component Tokens Tool (#24)
dominicmacaulay Feb 5, 2026
10c01d4
Extract Search Documentation Tool (#25)
dominicmacaulay Feb 5, 2026
d83afa4
Extract the replace hard coded values tool (#26)
Jeremy-Walton Feb 5, 2026
79fb28c
Extract remaining tools (#27)
dominicmacaulay Feb 5, 2026
6e042a8
Add sync-optics-data script
dallasbpeters Feb 5, 2026
a4db52a
Add component-tokens utility
dallasbpeters Feb 5, 2026
b38e927
Regenerate optics-data with 29 components
dallasbpeters Feb 5, 2026
e3ba6df
Add sync-data npm script and dev dependencies
dallasbpeters Feb 5, 2026
e0263fa
Add critical color pairing and component usage docs
dallasbpeters Feb 5, 2026
da3ad8c
Fix DesignToken interface compatibility in generate-theme-tool
dallasbpeters Feb 5, 2026
d3f91be
Enhance Optics with new prompts and tools for component building and …
dallasbpeters Feb 7, 2026
6a7df98
Resolve merge conflict in src/index.ts by consolidating tool imports …
dallasbpeters Feb 9, 2026
1f00208
Rebase: keep our versions of index.ts and replace-hard-coded-values-t…
dallasbpeters Feb 9, 2026
261ef2f
Rebase: keep our versions of resource-path, index.ts, generate-theme-…
dallasbpeters Feb 9, 2026
06405c2
Update README and package details to prep for publishing
Jeremy-Walton Feb 6, 2026
f36fdbb
Update workflow permissions (#29)
Jeremy-Walton Feb 6, 2026
55a09fd
Rebase: keep our consolidated index.ts (Validate Pairs Tool conflict)
dallasbpeters Feb 9, 2026
0b84862
Move tool markdown to src/tools/_templates and clean duplicates; read…
dallasbpeters Feb 9, 2026
5223ac5
Refactor index.ts to remove unused tool imports and consolidate tool …
dallasbpeters Feb 9, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ jobs:
- name: Build
run: npm run build

- name: Install playwright
run: npx playwright install

- name: Run tests
run: npm test

Expand Down
26 changes: 9 additions & 17 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,23 @@
name: Publish to GitHub Packages
name: Publish to NPM

on:
release:
types: [created]
workflow_dispatch:

types: [published]
permissions:
contents: write
jobs:
publish:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6

- uses: actions/setup-node@v4
- uses: actions/setup-node@v6
with:
node-version: '24.x'
registry-url: 'https://registry.npmjs.org'

- run: npm ci

- run: npm test

- name: Configure npm for GitHub Packages
run: |
echo "//npm.pkg.github.com/:_authToken=${{ secrets.GH_PAT }}" > ~/.npmrc
echo "@dallasbpeters:registry=https://npm.pkg.github.com" >> ~/.npmrc

- run: npm run build
- run: npm publish --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,7 @@ logs/
.cursor/rules/byterover-rules.mdc
.kiro/steering/byterover-rules.md
.qoder/rules/byterover-rules.md
.augment/rules/byterover-rules.md
.augment/rules/byterover-rules.md

# Vitest
spec/**/__screenshots__/*
64 changes: 37 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ graph TB

subgraph "Optics MCP Server"
SERVER[MCP Server<br/>stdio transport]

subgraph "Resources (13)"
SYSTEM[optics://system-overview]
DOC_INTRO[optics://documentation/introduction]
Expand All @@ -52,7 +52,7 @@ graph TB
TOK_TYPO[optics://tokens/typography]
COMP_ALL[optics://components/all]
end

subgraph "Core Tools (7)"
T1[get_token]
T2[search_tokens]
Expand All @@ -62,7 +62,7 @@ graph TB
T6[get_component_tokens]
T7[search_documentation]
end

subgraph "Advanced Tools (7)"
T8[generate_theme]
T9[validate_token_usage]
Expand All @@ -72,22 +72,22 @@ graph TB
T13[generate_component_scaffold]
T14[generate_sticker_sheet]
end

subgraph "Prompts (5)"
P1[start-here]
P2[get-token-reference]
P3[component-guide]
P4[theme-customization]
P5[migration-guide]
end

subgraph "Data Layer"
TOKENS[83 Design Tokens<br/>HSL colors, spacing,<br/>typography, borders, shadows]
COMPONENTS[24 Components<br/>with token dependencies]
DOCS[Documentation<br/>Guidelines & best practices]
end
end

CLIENT -->|JSON-RPC| SERVER
SERVER --> SYSTEM
SERVER --> DOC_INTRO
Expand Down Expand Up @@ -152,16 +152,20 @@ graph TB

1. Command Palette → **MCP: Open User Configuration**
2. Add this configuration:
```json
{
"servers": {
"optics": {
"command": "npx",
"args": ["-y", "optics-mcp"]
}
}
}
```

```json
{
"servers": {
"optics": {
"command": "npx",
"args": [
"@rolemodel/optics-mcp@latest"
]
}
}
}
```

3. Open GitHub Copilot in **Agent Mode**
4. Click the tools icon to see Optics tools available

Expand All @@ -180,16 +184,20 @@ cursor://anysphere.cursor-deeplink/mcp/install?name=optics&config=eyJvcHRpY3MiOn

1. Open Cursor Settings → **MCP**
2. Add this configuration:
```json
{
"servers": {
"optics": {
"command": "npx",
"args": ["-y", "optics-mcp"]
}
}
}
```

```json
{
"servers": {
"optics": {
"command": "npx",
"args": [
"@rolemodel/optics-mcp@latest"
]
}
}
}
```

3. Chat with Cursor AI to access Optics tools

### Quick Start (Zero-Install) ⚡
Expand All @@ -205,7 +213,9 @@ Add to your MCP configuration:
"mcpServers": {
"optics": {
"command": "npx",
"args": ["-y", "optics-mcp"]
"args": [
"@rolemodel/optics-mcp@latest"
]
}
}
}
Expand Down
9 changes: 9 additions & 0 deletions editor-configs/cursor-mcp.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"mcpServers": {
"optics": {
"command": "npx",
"args": ["-y", "@rolemodel/optics-mcp"],
"env": {}
}
}
}
Loading