@primevue/mcp 5.0.0-rc.2 → 5.0.0-rc.3
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.
- package/README.md +10 -8
- package/data/components.json +147 -77
- package/data/llms/components/accordion.md +1 -1
- package/data/llms/components/blockui.md +3 -1
- package/data/llms/components/button.md +1 -1
- package/data/llms/components/chart.md +1 -1
- package/data/llms/components/confirmdialog.md +8 -36
- package/data/llms/components/datatable.md +1 -1
- package/data/llms/components/datepicker.md +3 -1
- package/data/llms/components/dialog.md +8 -40
- package/data/llms/components/editor.md +0 -1
- package/data/llms/components/fileupload.md +7 -3
- package/data/llms/components/forms.md +3 -1
- package/data/llms/components/galleria.md +1 -1
- package/data/llms/components/inputgroup.md +0 -74
- package/data/llms/components/inputtags.md +0 -1
- package/data/llms/components/picklist.md +2 -2
- package/data/llms/components/toolbar.md +1 -1
- package/data/llms/components/treetable.md +1 -1
- package/data/llms/guides/cdn.md +2 -2
- package/data/llms/guides/icons.md +3 -3
- package/data/llms/guides/mcp.md +30 -54
- package/data/llms/guides/nuxt.md +6 -6
- package/data/llms/guides/plugin.md +99 -0
- package/data/llms/guides/theming/unstyled.md +1 -1
- package/data/llms/guides/vite.md +3 -3
- package/data/llms/llms-full.txt +189 -237
- package/data/llms/llms.txt +2 -1
- package/data/llms/pages/cdn.md +2 -2
- package/data/llms/pages/icons.md +3 -3
- package/data/llms/pages/mcp.md +30 -54
- package/data/llms/pages/nuxt.md +6 -6
- package/data/llms/pages/plugin.md +99 -0
- package/data/llms/pages/theming/unstyled.md +1 -1
- package/data/llms/pages/unstyled.md +1 -1
- package/data/llms/pages/vite.md +3 -3
- package/data/manifest.json +1141 -689
- package/data/mcp-data.json +288 -64
- package/dist/index.d.ts +3 -12
- package/dist/index.js +1438 -797
- package/package.json +5 -5
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# PrimeVue Plugin
|
|
2
|
+
|
|
3
|
+
Add PrimeVue workflow skills and the PrimeVue MCP server to your AI assistant with one installation.
|
|
4
|
+
|
|
5
|
+
## Introduction
|
|
6
|
+
|
|
7
|
+
The PrimeVue Plugin adds PrimeVue skills and the PrimeVue MCP server to Claude Code, Codex, GitHub Copilot, Cursor, or Gemini CLI. Plugins installed through GitHub Copilot CLI are also available in VS Code. Install the plugin when you want the assistant to follow PrimeVue-specific workflows as well as read the current component documentation. The plugin is published from the primefaces/primeui-plugins repository. Use @primeui/cli@1.0.0 for the same installation flow across supported assistants, or follow the manual setup for your client.
|
|
8
|
+
|
|
9
|
+
## What It Installs
|
|
10
|
+
|
|
11
|
+
Installing the PrimeVue Plugin adds: Seven skills for PrimeVue implementation, setup, theming, accessibility, migration, and troubleshooting. The PrimeVue MCP server, configured with @primevue/mcp@5.0.0 . The manifest required by the selected assistant. PrimeNG and PrimeReact are separate plugins. Installing this plugin does not change your application or install PrimeVue dependencies in the project.
|
|
12
|
+
|
|
13
|
+
## Skills
|
|
14
|
+
|
|
15
|
+
Each skill covers one type of PrimeVue work. The skills use @primevue/mcp@5.0.0 when they need component APIs, examples, setup guides, or usage validation. Skill Use it for primevue-router Choose the PrimeVue skill that matches the task. primevue-component-implementation Choose and implement components, forms, directives, and documented examples. primevue-setup-installation Install and configure PrimeVue in Vue, Vite, or Nuxt applications. primevue-theming-customization Configure presets, tokens, styled or unstyled mode, Tailwind, pass-through, slots, and events. primevue-accessibility-icons Review semantics, keyboard behavior, focus, accessible names, PrimeIcons, and custom icons. primevue-migration Plan and apply changes using the current PrimeVue migration guides. primevue-audit-troubleshooting Find invalid APIs and troubleshoot components, setup, MCP, plugin, or duplicate configurations. Skill names use the primevue- prefix because assistants may keep skills from several plugins in one shared namespace.
|
|
16
|
+
|
|
17
|
+
## How Skills Work
|
|
18
|
+
|
|
19
|
+
You do not need to select a skill manually. Describe the PrimeVue task and the router chooses the relevant workflow. The router checks that the project uses Vue and PrimeVue. The selected skill reads only the component or guide information needed for the task. When component metadata is available, the skill validates the final PrimeVue usage. If the documentation does not confirm a setup or API, the skill reports the limitation instead of guessing. After implementation, run the checks required by your project, including type checking, tests, browser behavior, accessibility, and visual review where applicable.
|
|
20
|
+
|
|
21
|
+
## CLI Setup
|
|
22
|
+
|
|
23
|
+
Set --tool to the assistant you use. Keep --library primevue when you run the command outside a project or from a project that uses more than one PrimeUI library.
|
|
24
|
+
|
|
25
|
+
```vue
|
|
26
|
+
pnpm dlx @primeui/cli@1.0.0 plugin install --tool copilot --library primevue
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Lifecycle and Doctor
|
|
30
|
+
|
|
31
|
+
Use the same CLI to check the installation, update the plugin, or remove it. Each command applies only to PrimeVue in the selected assistant. Run doctor when the plugin or MCP server is not working as expected. It checks the installation, starts the MCP server, confirms the available tools, and tests documentation retrieval and component validation. Checks that an assistant does not expose are reported as unsupported.
|
|
32
|
+
|
|
33
|
+
```vue
|
|
34
|
+
pnpm dlx @primeui/cli@1.0.0 plugin status --tool copilot --library primevue
|
|
35
|
+
pnpm dlx @primeui/cli@1.0.0 plugin update --tool copilot --library primevue
|
|
36
|
+
pnpm dlx @primeui/cli@1.0.0 plugin remove --tool copilot --library primevue
|
|
37
|
+
pnpm dlx @primeui/cli@1.0.0 doctor --tool copilot --library primevue
|
|
38
|
+
|
|
39
|
+
# Machine-readable diagnostics
|
|
40
|
+
pnpm dlx @primeui/cli@1.0.0 doctor --tool copilot --library primevue --json
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Source
|
|
44
|
+
|
|
45
|
+
Claude Code, Codex, and GitHub Copilot can install the plugin directly from the public marketplace. For manual Cursor or Gemini CLI setup, clone the repository to a location you intend to keep because those clients use the selected plugins/primevue directory after installation.
|
|
46
|
+
|
|
47
|
+
```vue
|
|
48
|
+
git clone --branch main https://github.com/primefaces/primeui-plugins.git ~/primeui-plugins
|
|
49
|
+
ls ~/primeui-plugins/plugins/primevue
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Claude Code
|
|
53
|
+
|
|
54
|
+
Add the PrimeUI marketplace, then install only the PrimeVue plugin.
|
|
55
|
+
|
|
56
|
+
```vue
|
|
57
|
+
claude plugin marketplace add primefaces/primeui-plugins
|
|
58
|
+
claude plugin install primevue@primeui
|
|
59
|
+
claude plugin list --json
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Codex
|
|
63
|
+
|
|
64
|
+
Add the PrimeUI marketplace, inspect its catalog, then install only the PrimeVue plugin. Use the interactive plugin browser to manage enablement.
|
|
65
|
+
|
|
66
|
+
```vue
|
|
67
|
+
codex plugin marketplace add primefaces/primeui-plugins
|
|
68
|
+
codex plugin list --available
|
|
69
|
+
codex plugin add primevue@primeui
|
|
70
|
+
codex plugin list
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## VS Code Copilot
|
|
74
|
+
|
|
75
|
+
Install the PrimeVue Plugin through GitHub Copilot CLI. VS Code automatically discovers plugins installed by Copilot CLI, so it does not need a separate plugin configuration.
|
|
76
|
+
|
|
77
|
+
```vue
|
|
78
|
+
copilot plugin marketplace add primefaces/primeui-plugins
|
|
79
|
+
copilot plugin install primevue@primeui
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Cursor
|
|
83
|
+
|
|
84
|
+
For local setup, link the PrimeVue plugin directory into Cursor's local-plugin directory. Restart Cursor or run Developer: Reload Window after creating the link.
|
|
85
|
+
|
|
86
|
+
```vue
|
|
87
|
+
mkdir -p ~/.cursor/plugins/local
|
|
88
|
+
ln -s ~/primeui-plugins/plugins/primevue ~/.cursor/plugins/local/primevue
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Gemini CLI
|
|
92
|
+
|
|
93
|
+
Validate the PrimeVue extension directory, then install it from the persistent checkout. Do not install from the repository root because it contains plugins for all three PrimeUI libraries.
|
|
94
|
+
|
|
95
|
+
```vue
|
|
96
|
+
gemini extensions validate ~/primeui-plugins/plugins/primevue
|
|
97
|
+
gemini extensions install ~/primeui-plugins/plugins/primevue --consent
|
|
98
|
+
gemini extensions list --output-format json
|
|
99
|
+
```
|
|
@@ -12,7 +12,7 @@ Unstyled mode is enabled for the whole suite by enabling unstyled option during
|
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
|
-
Here is a sample that styles a button component with Tailwind CSS using pass through attributes. Before beginning, head over to the
|
|
15
|
+
Here is a sample that styles a button component with Tailwind CSS using pass through attributes. Before beginning, head over to the pass through section at button documentation to learn more about the components internals section. We'll style the root element with pass through attributes, and apply utility classes directly to the icon and label placed in the default slot. Search
|
|
16
16
|
|
|
17
17
|
```vue
|
|
18
18
|
<template>
|
package/data/llms/guides/vite.md
CHANGED
|
@@ -8,13 +8,13 @@ PrimeVue is available for download on npm registry .
|
|
|
8
8
|
|
|
9
9
|
```vue
|
|
10
10
|
# Using npm
|
|
11
|
-
npm install primevue
|
|
11
|
+
npm install primevue @primeuix/themes
|
|
12
12
|
|
|
13
13
|
# Using yarn
|
|
14
|
-
yarn add primevue
|
|
14
|
+
yarn add primevue @primeuix/themes
|
|
15
15
|
|
|
16
16
|
# Using pnpm
|
|
17
|
-
pnpm add primevue
|
|
17
|
+
pnpm add primevue @primeuix/themes
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
## Plugin
|