@openvue/mcp 0.0.1-alpha.0 → 0.0.1-alpha.2

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 (4) hide show
  1. package/LICENSE.md +22 -0
  2. package/README.md +84 -84
  3. package/dist/index.js +1 -1
  4. package/package.json +61 -61
package/LICENSE.md ADDED
@@ -0,0 +1,22 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018-2025 PrimeTek
4
+ Copyright (c) 2026 OpenVue Foundation and contributors
5
+
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
package/README.md CHANGED
@@ -1,37 +1,37 @@
1
- # @primevue/mcp
1
+ # @openvue/mcp
2
2
 
3
- Model Context Protocol (MCP) server for PrimeVue component library. Provides AI assistants with comprehensive access to PrimeVue component documentation, props, events, slots, theming, and code examples.
3
+ Model Context Protocol (MCP) server for the [OpenVue](https://openvue.dev) component library. Provides AI assistants with comprehensive access to OpenVue component documentation, props, events, slots, theming, and code examples.
4
4
 
5
5
  ## What is MCP?
6
6
 
7
- [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that enables AI models to connect with external tools and data sources. By installing this MCP server, your AI assistant gains deep knowledge of PrimeVue components and can provide accurate, up-to-date information while helping you build Vue.js applications.
7
+ [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that enables AI models to connect with external tools and data sources. By installing this MCP server, your AI assistant gains deep knowledge of OpenVue components and can provide accurate, up-to-date information while helping you build Vue.js applications.
8
8
 
9
9
  ## Installation
10
10
 
11
11
  ### Claude Code
12
12
 
13
- Add the PrimeVue MCP server using the CLI:
13
+ Add the OpenVue MCP server using the CLI:
14
14
 
15
15
  ```bash
16
16
  # Add to your user config (available in all projects)
17
- claude mcp add primevue -s user -- npx -y @primevue/mcp
17
+ claude mcp add openvue -s user -- npx -y @openvue/mcp
18
18
 
19
19
  # Or add to current project only
20
- claude mcp add primevue -- npx -y @primevue/mcp
20
+ claude mcp add openvue -- npx -y @openvue/mcp
21
21
  ```
22
22
 
23
23
  Alternatively, use the JSON format for more control:
24
24
 
25
25
  ```bash
26
- claude mcp add-json primevue '{"command":"npx","args":["-y","@primevue/mcp"]}' -s user
26
+ claude mcp add-json openvue '{"command":"npx","args":["-y","@openvue/mcp"]}' -s user
27
27
  ```
28
28
 
29
29
  **Useful commands:**
30
30
 
31
31
  ```bash
32
- claude mcp list # List all MCP servers
33
- claude mcp get primevue # Get server details
34
- claude mcp remove primevue # Remove the server
32
+ claude mcp list # List all MCP servers
33
+ claude mcp get openvue # Get server details
34
+ claude mcp remove openvue # Remove the server
35
35
  ```
36
36
 
37
37
  After adding, start a new Claude Code session and use `/mcp` to verify the connection.
@@ -49,9 +49,9 @@ Create `.cursor/mcp.json` in your project:
49
49
  ```json
50
50
  {
51
51
  "mcpServers": {
52
- "primevue": {
52
+ "openvue": {
53
53
  "command": "npx",
54
- "args": ["-y", "@primevue/mcp"]
54
+ "args": ["-y", "@openvue/mcp"]
55
55
  }
56
56
  }
57
57
  }
@@ -64,9 +64,9 @@ Create or edit `~/.cursor/mcp.json` in your home directory:
64
64
  ```json
65
65
  {
66
66
  "mcpServers": {
67
- "primevue": {
67
+ "openvue": {
68
68
  "command": "npx",
69
- "args": ["-y", "@primevue/mcp"]
69
+ "args": ["-y", "@openvue/mcp"]
70
70
  }
71
71
  }
72
72
  }
@@ -78,7 +78,7 @@ Create or edit `~/.cursor/mcp.json` in your home directory:
78
78
  2. Click **New MCP Server**
79
79
  3. Add the configuration above
80
80
 
81
- After adding, go to **Settings > MCP** and click the refresh button. The Composer Agent will automatically use PrimeVue tools when relevant.
81
+ After adding, go to **Settings > MCP** and click the refresh button. The Composer Agent will automatically use OpenVue tools when relevant.
82
82
 
83
83
  > **Reference:** [Cursor MCP Documentation](https://docs.cursor.com/context/model-context-protocol)
84
84
 
@@ -93,9 +93,9 @@ Create `.vscode/mcp.json` in your project:
93
93
  ```json
94
94
  {
95
95
  "servers": {
96
- "primevue": {
96
+ "openvue": {
97
97
  "command": "npx",
98
- "args": ["-y", "@primevue/mcp"]
98
+ "args": ["-y", "@openvue/mcp"]
99
99
  }
100
100
  }
101
101
  }
@@ -112,9 +112,9 @@ Create or edit the MCP configuration file in your VS Code user data directory:
112
112
  ```json
113
113
  {
114
114
  "servers": {
115
- "primevue": {
115
+ "openvue": {
116
116
  "command": "npx",
117
- "args": ["-y", "@primevue/mcp"]
117
+ "args": ["-y", "@openvue/mcp"]
118
118
  }
119
119
  }
120
120
  }
@@ -125,11 +125,11 @@ Create or edit the MCP configuration file in your VS Code user data directory:
125
125
  1. Open Command Palette (`Cmd+Shift+P` / `Ctrl+Shift+P`)
126
126
  2. Type "MCP: Add Server"
127
127
  3. Select "Command (stdio)"
128
- 4. Enter `primevue` as the server ID
128
+ 4. Enter `openvue` as the server ID
129
129
  5. Enter `npx` as the command
130
- 6. Enter `-y,@primevue/mcp` as the arguments
130
+ 6. Enter `-y,@openvue/mcp` as the arguments
131
131
 
132
- After adding, use Copilot in **Agent mode** to access PrimeVue tools. The MCP server will be available in GitHub Copilot Chat.
132
+ After adding, use Copilot in **Agent mode** to access OpenVue tools. The MCP server will be available in GitHub Copilot Chat.
133
133
 
134
134
  > **Reference:** [VS Code MCP Documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
135
135
 
@@ -140,7 +140,7 @@ After adding, use Copilot in **Agent mode** to access PrimeVue tools. The MCP se
140
140
  **Option 1: Using the CLI**
141
141
 
142
142
  ```bash
143
- codex mcp add primevue -- npx -y @primevue/mcp
143
+ codex mcp add openvue -- npx -y @openvue/mcp
144
144
  ```
145
145
 
146
146
  **Option 2: Direct Configuration**
@@ -148,9 +148,9 @@ codex mcp add primevue -- npx -y @primevue/mcp
148
148
  Edit `~/.codex/config.toml`:
149
149
 
150
150
  ```toml
151
- [mcp_servers.primevue]
151
+ [mcp_servers.openvue]
152
152
  command = "npx"
153
- args = ["-y", "@primevue/mcp"]
153
+ args = ["-y", "@openvue/mcp"]
154
154
  ```
155
155
 
156
156
  After adding, the MCP server will be available in both the Codex CLI and VS Code extension.
@@ -175,9 +175,9 @@ Edit `~/.codeium/windsurf/mcp_config.json`:
175
175
  ```json
176
176
  {
177
177
  "mcpServers": {
178
- "primevue": {
178
+ "openvue": {
179
179
  "command": "npx",
180
- "args": ["-y", "@primevue/mcp"]
180
+ "args": ["-y", "@openvue/mcp"]
181
181
  }
182
182
  }
183
183
  }
@@ -196,17 +196,17 @@ Add to your Zed settings (`~/.config/zed/settings.json` on Linux, `~/Library/App
196
196
  ```json
197
197
  {
198
198
  "context_servers": {
199
- "primevue": {
199
+ "openvue": {
200
200
  "command": {
201
201
  "path": "npx",
202
- "args": ["-y", "@primevue/mcp"]
202
+ "args": ["-y", "@openvue/mcp"]
203
203
  }
204
204
  }
205
205
  }
206
206
  }
207
207
  ```
208
208
 
209
- After adding, restart Zed. Check the Agent Panel's settings view - a green indicator dot next to "primevue" confirms the server is active.
209
+ After adding, restart Zed. Check the Agent Panel's settings view - a green indicator dot next to "openvue" confirms the server is active.
210
210
 
211
211
  > **Reference:** [Zed MCP Documentation](https://zed.dev/docs/ai/mcp)
212
212
 
@@ -217,82 +217,82 @@ After adding, restart Zed. Check the Agent Panel's settings view - a green indic
217
217
  ### Component Information
218
218
 
219
219
  | Tool | Description |
220
- | ----------------------- | -------------------------------------------- |
221
- | `list_components` | List all PrimeVue components with categories |
220
+ | ----------------------- | --------------------------------------------- |
221
+ | `list_components` | List all OpenVue components with categories |
222
222
  | `get_component` | Get detailed info about a specific component |
223
223
  | `search_components` | Search components by name or description |
224
224
  | `get_component_props` | Get all props for a component |
225
- | `get_component_events` | Get all events for a component |
226
- | `get_component_methods` | Get all methods for a component |
227
- | `get_component_slots` | Get all slots for a component |
228
- | `compare_components` | Compare two components side by side |
229
- | `get_categories` | Get all component categories |
225
+ | `get_component_events` | Get all events for a component |
226
+ | `get_component_methods` | Get all methods for a component |
227
+ | `get_component_slots` | Get all slots for a component |
228
+ | `compare_components` | Compare two components side by side |
229
+ | `get_categories` | Get all component categories |
230
230
 
231
231
  ### Code Examples
232
232
 
233
233
  | Tool | Description |
234
- | ----------------------------- | ----------------------------------------------- |
234
+ | ----------------------------- | ------------------------------------------------ |
235
235
  | `get_usage_example` | Get code examples for a component |
236
236
  | `list_examples` | List all available code examples |
237
237
  | `get_example` | Get a specific example by component and section |
238
- | `generate_component_template` | Generate a basic component template |
238
+ | `generate_component_template` | Generate a basic component template |
239
239
 
240
240
  ### Theming & Styling
241
241
 
242
- | Tool | Description |
243
- | ----------------------- | ---------------------------------------------- |
244
- | `get_component_pt` | Get Pass Through options for DOM customization |
245
- | `get_component_tokens` | Get design tokens (CSS variables) |
246
- | `get_component_styles` | Get CSS class names |
247
- | `get_theming_info` | Get theming information |
248
- | `get_theming_guide` | Get detailed theming guide |
249
- | `get_passthrough_guide` | Get Pass Through customization guide |
250
- | `get_tailwind_guide` | Get Tailwind CSS integration guide |
242
+ | Tool | Description |
243
+ | ------------------------ | ------------------------------------------------ |
244
+ | `get_component_pt` | Get Pass Through options for DOM customization |
245
+ | `get_component_tokens` | Get design tokens (CSS variables) |
246
+ | `get_component_styles` | Get CSS class names |
247
+ | `get_theming_info` | Get theming information |
248
+ | `get_theming_guide` | Get detailed theming guide |
249
+ | `get_passthrough_guide` | Get Pass Through customization guide |
250
+ | `get_tailwind_guide` | Get Tailwind CSS integration guide |
251
251
 
252
252
  ### Documentation & Guides
253
253
 
254
- | Tool | Description |
255
- | ------------------------- | --------------------------------------- |
256
- | `list_guides` | List all guides and documentation pages |
257
- | `get_guide` | Get a specific guide by name |
258
- | `get_configuration` | Get PrimeVue configuration options |
259
- | `get_installation` | Get installation instructions |
260
- | `get_icons_guide` | Get icons usage guide |
261
- | `get_accessibility_guide` | Get accessibility guide |
262
- | `get_accessibility_info` | Get accessibility info for a component |
254
+ | Tool | Description |
255
+ | -------------------------- | ------------------------------------------ |
256
+ | `list_guides` | List all guides and documentation pages |
257
+ | `get_guide` | Get a specific guide by name |
258
+ | `get_configuration` | Get OpenVue configuration options |
259
+ | `get_installation` | Get installation instructions |
260
+ | `get_icons_guide` | Get icons usage guide |
261
+ | `get_accessibility_guide` | Get accessibility guide |
262
+ | `get_accessibility_info` | Get accessibility info for a component |
263
263
 
264
264
  ### Search & Discovery
265
265
 
266
- | Tool | Description |
267
- | ------------------------------ | ------------------------------------------- |
268
- | `search_all` | Search across components, guides, and props |
269
- | `suggest_component` | Suggest components based on use case |
270
- | `find_by_prop` | Find components with a specific prop |
271
- | `find_by_event` | Find components that emit a specific event |
272
- | `find_components_with_feature` | Find components supporting a feature |
273
- | `get_related_components` | Find related components |
266
+ | Tool | Description |
267
+ | -------------------------------- | ----------------------------------------------- |
268
+ | `search_all` | Search across components, guides, and props |
269
+ | `suggest_component` | Suggest components based on use case |
270
+ | `find_by_prop` | Find components with a specific prop |
271
+ | `find_by_event` | Find components that emit a specific event |
272
+ | `find_components_with_feature` | Find components supporting a feature |
273
+ | `get_related_components` | Find related components |
274
274
 
275
275
  ### Utilities
276
276
 
277
- | Tool | Description |
278
- | ------------------------ | ----------------------------------------- |
279
- | `get_component_url` | Get the official documentation URL |
280
- | `get_component_import` | Get the correct import statement |
281
- | `get_component_sections` | Get all sections/features for a component |
282
- | `validate_props` | Validate props for a component |
283
- | `export_component_docs` | Export documentation in markdown |
284
- | `get_form_components` | Get all form input components |
285
- | `get_data_components` | Get all data display components |
286
- | `get_overlay_components` | Get all overlay/popup components |
287
- | `get_performance_tips` | Get performance optimization tips |
288
- | `get_version_info` | Get version and compatibility info |
277
+ | Tool | Description |
278
+ | ------------------------- | --------------------------------------------- |
279
+ | `get_component_url` | Get the official documentation URL |
280
+ | `get_component_import` | Get the correct import statement |
281
+ | `get_component_sections` | Get all sections/features for a component |
282
+ | `validate_props` | Validate props for a component |
283
+ | `export_component_docs` | Export documentation in markdown |
284
+ | `get_form_components` | Get all form input components |
285
+ | `get_data_components` | Get all data display components |
286
+ | `get_overlay_components` | Get all overlay/popup components |
287
+ | `get_performance_tips` | Get performance optimization tips |
288
+ | `get_version_info` | Get version and compatibility info |
289
289
 
290
290
  ### Vue Composables
291
291
 
292
- | Tool | Description |
293
- | ------------------ | --------------------------------------- |
294
- | `list_composables` | List all PrimeVue composables |
295
- | `get_composable` | Get details about a specific composable |
292
+ | Tool | Description |
293
+ | -------------------- | ------------------------------------------- |
294
+ | `list_composables` | List all OpenVue composables |
295
+ | `get_composable` | Get details about a specific composable |
296
296
 
297
297
  ## Example Prompts
298
298
 
@@ -312,10 +312,10 @@ Once installed, try asking your AI assistant:
312
312
 
313
313
  ## Links
314
314
 
315
- - [PrimeVue Documentation](https://primevue.org/)
315
+ - [OpenVue website](https://openvue.dev)
316
316
  - [Model Context Protocol](https://modelcontextprotocol.io/)
317
- - [GitHub Repository](https://github.com/primefaces/primevue)
318
- - [Report Issues](https://github.com/primefaces/primevue/issues)
317
+ - [GitHub Repository](https://github.com/openvi-foundation/openvue)
318
+ - [Report Issues](https://github.com/openvi-foundation/openvue/issues)
319
319
 
320
320
  ## License
321
321
 
package/dist/index.js CHANGED
@@ -73542,7 +73542,7 @@ const items = [
73542
73542
  // package.json
73543
73543
  var package_default = {
73544
73544
  name: "@openvue/mcp",
73545
- version: "0.0.1-alpha.0",
73545
+ version: "0.0.1-alpha.2",
73546
73546
  author: "OpenVue Contributors",
73547
73547
  description: "Model Context Protocol (MCP) server for PrimeVue component library",
73548
73548
  homepage: "https://github.com/openvi-foundation/openvue",
package/package.json CHANGED
@@ -1,63 +1,63 @@
1
1
  {
2
- "name": "@openvue/mcp",
3
- "version": "0.0.1-alpha.0",
4
- "author": "OpenVue Contributors",
5
- "description": "Model Context Protocol (MCP) server for PrimeVue component library",
6
- "homepage": "https://github.com/openvi-foundation/openvue",
7
- "license": "MIT",
8
- "repository": {
9
- "type": "git",
10
- "url": "https://github.com/openvi-foundation/openvue.git",
11
- "directory": "packages/mcp"
12
- },
13
- "bugs": {
14
- "url": "https://github.com/openvi-foundation/openvue/issues"
15
- },
16
- "keywords": [
17
- "primevue",
18
- "openvue",
19
- "mcp",
20
- "model-context-protocol",
21
- "ai",
22
- "llm",
23
- "vue",
24
- "components"
25
- ],
26
- "bin": {
27
- "openvue-mcp": "./dist/index.js"
28
- },
29
- "type": "module",
30
- "main": "./dist/index.js",
31
- "module": "./dist/index.js",
32
- "types": "./dist/index.d.ts",
33
- "exports": {
34
- ".": {
35
- "types": "./dist/index.d.ts",
36
- "import": "./dist/index.js",
37
- "default": "./dist/index.js"
38
- }
39
- },
40
- "publishConfig": {
41
- "access": "public"
42
- },
43
- "files": [
44
- "dist",
45
- "README.md",
46
- "LICENSE"
47
- ],
48
- "scripts": {
49
- "build": "NODE_ENV=production INPUT_DIR=src/ OUTPUT_DIR=dist/ pnpm run build:package",
50
- "build:package": "pnpm run build:prebuild && tsup",
51
- "build:prebuild": "node ./scripts/prebuild.mjs",
52
- "dev:link": "pnpm link --global && npm link"
53
- },
54
- "dependencies": {
55
- "@primeuix/mcp": "catalog:"
56
- },
57
- "devDependencies": {
58
- "tsup": "^8.1.0"
59
- },
60
- "engines": {
61
- "node": ">=12.11.0"
2
+ "name": "@openvue/mcp",
3
+ "version": "0.0.1-alpha.2",
4
+ "author": "OpenVue Contributors",
5
+ "description": "Model Context Protocol (MCP) server for PrimeVue component library",
6
+ "homepage": "https://github.com/openvi-foundation/openvue",
7
+ "license": "MIT",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "https://github.com/openvi-foundation/openvue.git",
11
+ "directory": "packages/mcp"
12
+ },
13
+ "bugs": {
14
+ "url": "https://github.com/openvi-foundation/openvue/issues"
15
+ },
16
+ "keywords": [
17
+ "primevue",
18
+ "openvue",
19
+ "mcp",
20
+ "model-context-protocol",
21
+ "ai",
22
+ "llm",
23
+ "vue",
24
+ "components"
25
+ ],
26
+ "bin": {
27
+ "openvue-mcp": "./dist/index.js"
28
+ },
29
+ "type": "module",
30
+ "main": "./dist/index.js",
31
+ "module": "./dist/index.js",
32
+ "types": "./dist/index.d.ts",
33
+ "exports": {
34
+ ".": {
35
+ "types": "./dist/index.d.ts",
36
+ "import": "./dist/index.js",
37
+ "default": "./dist/index.js"
62
38
  }
63
- }
39
+ },
40
+ "publishConfig": {
41
+ "access": "public"
42
+ },
43
+ "files": [
44
+ "dist",
45
+ "README.md",
46
+ "LICENSE"
47
+ ],
48
+ "dependencies": {
49
+ "@primeuix/mcp": "^1.0.0"
50
+ },
51
+ "devDependencies": {
52
+ "tsup": "^8.1.0"
53
+ },
54
+ "engines": {
55
+ "node": ">=12.11.0"
56
+ },
57
+ "scripts": {
58
+ "build": "NODE_ENV=production INPUT_DIR=src/ OUTPUT_DIR=dist/ pnpm run build:package",
59
+ "build:package": "pnpm run build:prebuild && tsup",
60
+ "build:prebuild": "node ./scripts/prebuild.mjs",
61
+ "dev:link": "pnpm link --global && npm link"
62
+ }
63
+ }