Skip to content

Commit 06405c2

Browse files
Jeremy-Waltondallasbpeters
authored andcommitted
Update README and package details to prep for publishing
1 parent 261ef2f commit 06405c2

File tree

4 files changed

+52
-48
lines changed

4 files changed

+52
-48
lines changed

.github/workflows/publish.yml

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
name: Publish to GitHub Packages
1+
name: Publish to NPM
22

33
on:
44
release:
5-
types: [created]
6-
workflow_dispatch:
5+
types: [published]
76

87
jobs:
98
publish:
@@ -12,20 +11,15 @@ jobs:
1211
contents: read
1312
packages: write
1413
steps:
15-
- uses: actions/checkout@v4
14+
- uses: actions/checkout@v6
1615

17-
- uses: actions/setup-node@v4
16+
- uses: actions/setup-node@v6
1817
with:
1918
node-version: '24.x'
2019
registry-url: 'https://registry.npmjs.org'
2120

2221
- run: npm ci
23-
24-
- run: npm test
25-
26-
- name: Configure npm for GitHub Packages
27-
run: |
28-
echo "//npm.pkg.github.com/:_authToken=${{ secrets.GH_PAT }}" > ~/.npmrc
29-
echo "@dallasbpeters:registry=https://npm.pkg.github.com" >> ~/.npmrc
30-
22+
- run: npm run build
3123
- run: npm publish --access public
24+
env:
25+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ graph TB
3535
3636
subgraph "Optics MCP Server"
3737
SERVER[MCP Server<br/>stdio transport]
38-
38+
3939
subgraph "Resources (13)"
4040
SYSTEM[optics://system-overview]
4141
DOC_INTRO[optics://documentation/introduction]
@@ -52,7 +52,7 @@ graph TB
5252
TOK_TYPO[optics://tokens/typography]
5353
COMP_ALL[optics://components/all]
5454
end
55-
55+
5656
subgraph "Core Tools (7)"
5757
T1[get_token]
5858
T2[search_tokens]
@@ -62,7 +62,7 @@ graph TB
6262
T6[get_component_tokens]
6363
T7[search_documentation]
6464
end
65-
65+
6666
subgraph "Advanced Tools (7)"
6767
T8[generate_theme]
6868
T9[validate_token_usage]
@@ -72,22 +72,22 @@ graph TB
7272
T13[generate_component_scaffold]
7373
T14[generate_sticker_sheet]
7474
end
75-
75+
7676
subgraph "Prompts (5)"
7777
P1[start-here]
7878
P2[get-token-reference]
7979
P3[component-guide]
8080
P4[theme-customization]
8181
P5[migration-guide]
8282
end
83-
83+
8484
subgraph "Data Layer"
8585
TOKENS[83 Design Tokens<br/>HSL colors, spacing,<br/>typography, borders, shadows]
8686
COMPONENTS[24 Components<br/>with token dependencies]
8787
DOCS[Documentation<br/>Guidelines & best practices]
8888
end
8989
end
90-
90+
9191
CLIENT -->|JSON-RPC| SERVER
9292
SERVER --> SYSTEM
9393
SERVER --> DOC_INTRO
@@ -152,16 +152,20 @@ graph TB
152152

153153
1. Command Palette → **MCP: Open User Configuration**
154154
2. Add this configuration:
155-
```json
156-
{
157-
"servers": {
158-
"optics": {
159-
"command": "npx",
160-
"args": ["-y", "optics-mcp"]
161-
}
162-
}
163-
}
164-
```
155+
156+
```json
157+
{
158+
"servers": {
159+
"optics": {
160+
"command": "npx",
161+
"args": [
162+
"@rolemodel/optics-mcp@latest"
163+
]
164+
}
165+
}
166+
}
167+
```
168+
165169
3. Open GitHub Copilot in **Agent Mode**
166170
4. Click the tools icon to see Optics tools available
167171

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

181185
1. Open Cursor Settings → **MCP**
182186
2. Add this configuration:
183-
```json
184-
{
185-
"servers": {
186-
"optics": {
187-
"command": "npx",
188-
"args": ["-y", "optics-mcp"]
189-
}
190-
}
191-
}
192-
```
187+
188+
```json
189+
{
190+
"servers": {
191+
"optics": {
192+
"command": "npx",
193+
"args": [
194+
"@rolemodel/optics-mcp@latest"
195+
]
196+
}
197+
}
198+
}
199+
```
200+
193201
3. Chat with Cursor AI to access Optics tools
194202

195203
### Quick Start (Zero-Install) ⚡
@@ -205,7 +213,9 @@ Add to your MCP configuration:
205213
"mcpServers": {
206214
"optics": {
207215
"command": "npx",
208-
"args": ["-y", "optics-mcp"]
216+
"args": [
217+
"@rolemodel/optics-mcp@latest"
218+
]
209219
}
210220
}
211221
}

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"name": "optics-mcp",
3-
"version": "0.2.6",
4-
"mcpName": "io.github.RoleModel/optics-mcp",
2+
"name": "@rolemodel/optics-mcp",
3+
"version": "0.2.7",
54
"description": "MCP Server for Optics Design System documentation and token usage with AI-optimized comprehension guide",
5+
"mcpName": "io.github.rolemodel/optics-mcp",
66
"main": "dist/index.js",
77
"type": "module",
88
"bin": {
9-
"optics-mcp": "dist/index.js"
9+
"@rolemodel/optics-mcp": "dist/index.js"
1010
},
1111
"scripts": {
1212
"build": "npx tsc && npm run copy:md",

0 commit comments

Comments
 (0)