Skip to content

Commit c8ab724

Browse files
committed
Update README to include Vue framework support alongside React and Svelte.
1 parent 8e721a6 commit c8ab724

File tree

1 file changed

+98
-6
lines changed

1 file changed

+98
-6
lines changed

README.md

Lines changed: 98 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,15 @@ npx @jpisnice/shadcn-ui-mcp-server --framework vue --github-api-key ghp_your_tok
4646
# Using environment variable for framework
4747
export FRAMEWORK=svelte
4848
npx @jpisnice/shadcn-ui-mcp-server
49+
50+
# Or use Vue
51+
export FRAMEWORK=vue
52+
npx @jpisnice/shadcn-ui-mcp-server
4953
```
5054

5155
**🎯 Try it now**: Run `npx @jpisnice/shadcn-ui-mcp-server --help` to see all options!
5256

53-
**🔄 Framework Selection**: The server supports both React (shadcn/ui) and Svelte (shadcn-svelte) implementations. Use `--framework svelte` to switch to Svelte components.
57+
**🔄 Framework Selection**: The server supports React (shadcn/ui), Svelte (shadcn-svelte), and Vue (shadcn-vue) implementations. Use `--framework svelte` or `--framework vue` to switch frameworks.
5458

5559
### 🔧 Command Line Options
5660

@@ -59,13 +63,13 @@ shadcn-ui-mcp-server [options]
5963

6064
Options:
6165
--github-api-key, -g <token> GitHub Personal Access Token
62-
--framework, -f <framework> Framework to use: 'react' or 'svelte' (default: react)
66+
--framework, -f <framework> Framework to use: 'react', 'svelte' or 'vue' (default: react)
6367
--help, -h Show help message
6468
--version, -v Show version information
6569

6670
Environment Variables:
6771
GITHUB_PERSONAL_ACCESS_TOKEN Alternative way to provide GitHub token
68-
FRAMEWORK Framework to use: 'react' or 'svelte' (default: react)
72+
FRAMEWORK Framework to use: 'react', 'svelte' or 'vue' (default: react)
6973

7074
Examples:
7175
npx @jpisnice/shadcn-ui-mcp-server --help
@@ -131,6 +135,7 @@ The MCP server supports both **React** (shadcn/ui) and **Svelte** (shadcn-svelte
131135
| ------------------- | ------------------------- | -------------- | ------------------------------------ |
132136
| **React** (default) | `shadcn-ui/ui` | `.tsx` | React components from shadcn/ui v4 |
133137
| **Svelte** | `huntabyte/shadcn-svelte` | `.svelte` | Svelte components from shadcn-svelte |
138+
| **Vue** | `unovue/shadcn-vue` | `.vue` | Vue components from shadcn-vue |
134139

135140
### 🎯 How to Switch Frameworks
136141

@@ -164,8 +169,13 @@ npx @jpisnice/shadcn-ui-mcp-server
164169
export FRAMEWORK=react
165170
npx @jpisnice/shadcn-ui-mcp-server
166171

172+
# Use Vue
173+
export FRAMEWORK=vue
174+
npx @jpisnice/shadcn-ui-mcp-server
175+
167176
# Or set for single command
168177
FRAMEWORK=svelte npx @jpisnice/shadcn-ui-mcp-server
178+
FRAMEWORK=vue npx @jpisnice/shadcn-ui-mcp-server
169179
```
170180

171181
**Method 3: Combined with GitHub Token**
@@ -176,6 +186,9 @@ npx @jpisnice/shadcn-ui-mcp-server --framework svelte --github-api-key ghp_your_
176186

177187
# React with GitHub token (default)
178188
npx @jpisnice/shadcn-ui-mcp-server --github-api-key ghp_your_token_here
189+
190+
# Vue with GitHub token
191+
npx @jpisnice/shadcn-ui-mcp-server --framework vue --github-api-key ghp_your_token_here
179192
```
180193

181194
### 🔍 Framework Detection
@@ -189,6 +202,13 @@ INFO: Repository: huntabyte/shadcn-svelte
189202
INFO: File extension: .svelte
190203
```
191204

205+
```bash
206+
INFO: Framework set to 'vue' via command line argument
207+
INFO: MCP Server configured for VUE framework
208+
INFO: Repository: unovue/shadcn-vue
209+
INFO: File extension: .vue
210+
```
211+
192212
**⚠️ Important**: When using environment variables, make sure to use the correct syntax:
193213

194214
- ✅ Correct: `export FRAMEWORK=svelte && npx @jpisnice/shadcn-ui-mcp-server`
@@ -199,8 +219,9 @@ INFO: File extension: .svelte
199219

200220
- **React Projects**: Use default or `--framework react` for React/Next.js applications
201221
- **Svelte Projects**: Use `--framework svelte` for Svelte/SvelteKit applications
222+
- **Vue Projects**: Use `--framework vue` for Vue/Nuxt applications
202223
- **Multi-Framework Development**: Switch between frameworks to compare implementations
203-
- **Learning**: Explore both React and Svelte versions of the same components
224+
- **Learning**: Explore React, Svelte, and Vue versions of the same components
204225

205226
## 🛠️ Editor Integration
206227

@@ -241,6 +262,17 @@ INFO: File extension: .svelte
241262
"--github-api-key",
242263
"ghp_your_token_here"
243264
]
265+
},
266+
// If using Vue, do this instead:
267+
"shadcn-ui-vue": {
268+
"command": "npx",
269+
"args": [
270+
"@jpisnice/shadcn-ui-mcp-server",
271+
"--framework",
272+
"vue",
273+
"--github-api-key",
274+
"ghp_your_token_here"
275+
]
244276
}
245277
}
246278
}
@@ -274,6 +306,14 @@ INFO: File extension: .svelte
274306
"env": {
275307
"GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_your_token_here"
276308
}
309+
},
310+
// If using Vue, do this instead:
311+
"shadcn-ui-vue": {
312+
"command": "npx",
313+
"args": ["@jpisnice/shadcn-ui-mcp-server", "--framework", "vue"],
314+
"env": {
315+
"GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_your_token_here"
316+
}
277317
}
278318
}
279319
}
@@ -311,6 +351,17 @@ INFO: File extension: .svelte
311351
"--github-api-key",
312352
"ghp_your_token_here"
313353
]
354+
},
355+
// If using Vue, do this instead:
356+
"shadcn-ui-vue": {
357+
"command": "npx",
358+
"args": [
359+
"@jpisnice/shadcn-ui-mcp-server",
360+
"--framework",
361+
"vue",
362+
"--github-api-key",
363+
"ghp_your_token_here"
364+
]
314365
}
315366
}
316367
}
@@ -337,6 +388,14 @@ Create a `.cursorrules` file in your project root:
337388
"env": {
338389
"GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_your_token_here"
339390
}
391+
},
392+
// If using Vue, do this instead:
393+
"shadcn-ui-vue": {
394+
"command": "npx",
395+
"args": ["@jpisnice/shadcn-ui-mcp-server", "--framework", "vue"],
396+
"env": {
397+
"GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_your_token_here"
398+
}
340399
}
341400
}
342401
}
@@ -367,6 +426,17 @@ Add to your Claude Desktop configuration (`~/.config/Claude/claude_desktop_confi
367426
"--github-api-key",
368427
"ghp_your_token_here"
369428
]
429+
},
430+
// If using Vue, do this instead:
431+
"shadcn-ui-vue": {
432+
"command": "npx",
433+
"args": [
434+
"@jpisnice/shadcn-ui-mcp-server",
435+
"--framework",
436+
"vue",
437+
"--github-api-key",
438+
"ghp_your_token_here"
439+
]
370440
}
371441
}
372442
}
@@ -420,7 +490,7 @@ Or with environment variable:
420490
}
421491
```
422492

423-
Or for Svelte:
493+
For Svelte:
424494

425495
```json
426496
{
@@ -436,13 +506,30 @@ Or for Svelte:
436506
}
437507
```
438508

509+
Or for Vue:
510+
511+
```json
512+
{
513+
"name": "shadcn-ui-vue",
514+
"command": "npx",
515+
"args": [
516+
"@jpisnice/shadcn-ui-mcp-server",
517+
"--framework",
518+
"vue",
519+
"--github-api-key",
520+
"ghp_your_token_here"
521+
]
522+
}
523+
```
524+
439525
## 🎯 Usage Examples
440526

441527
### Getting Component Source Code
442528

443529
Ask your AI assistant:
444530

445531
```
532+
446533
"Show me the source code for the shadcn/ui button component"
447534
```
448535

@@ -453,7 +540,9 @@ The AI can now access the complete TypeScript source code for the button compone
453540
Ask your AI assistant:
454541

455542
```
543+
456544
"Create a dashboard using shadcn/ui components. Use the dashboard-01 block as a starting point"
545+
457546
```
458547

459548
The AI can retrieve the complete dashboard block implementation and customize it for your needs.
@@ -463,7 +552,9 @@ The AI can retrieve the complete dashboard block implementation and customize it
463552
Ask your AI assistant:
464553

465554
```
555+
466556
"Help me build a login form using shadcn/ui components. Show me the available form components"
557+
467558
```
468559

469560
The AI can list all available components and help you build the form.
@@ -589,7 +680,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
589680
## 🔗 Related Projects
590681

591682
- [shadcn/ui](https://ui.shadcn.com/) - React component library (default framework)
592-
- [shadcn-svelte](https://www.shadcn-svelte.com/) - Svelte component library (use `--framework svelte`)
683+
- [shadcn-svelte](https://www.shadcn-svelte.com/) - Svelte component library
684+
- [shadcn-vue](https://www.shadcn-vue.com/) - Vue component library
593685
- [Model Context Protocol](https://modelcontextprotocol.io/) - The protocol specification
594686
- [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk) - Official MCP SDK
595687

0 commit comments

Comments
 (0)