@primereact/mcp 11.0.0-rc.3 → 11.0.0-rc.4
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 +8 -9
- package/data/llms/headless/components/carousel/api.json +1 -1
- package/data/llms/headless/components/contextmenu/api.json +2 -2
- package/data/llms/headless/components/inputcolor/api.json +1 -1
- package/data/llms/headless/components/menu/api.json +2 -2
- package/data/llms/headless/guides/ai/mcp.md +9 -9
- package/data/llms/headless/guides/ai/plugin.md +12 -11
- package/data/llms/llms-full.txt +109 -99
- package/data/llms/primitive/components/carousel/api.json +1 -1
- package/data/llms/primitive/components/contextmenu/api.json +2 -2
- package/data/llms/primitive/components/inputcolor/api.json +1 -1
- package/data/llms/primitive/components/menu/api.json +8 -8
- package/data/llms/primitive/guides/ai/mcp.md +9 -9
- package/data/llms/primitive/guides/ai/plugin.md +12 -11
- package/data/llms/styled/components/dialog.md +11 -8
- package/data/llms/styled/components/fileupload.md +3 -3
- package/data/llms/styled/guides/ai/mcp.md +9 -9
- package/data/llms/styled/guides/ai/plugin.md +12 -11
- package/data/llms/tailwind/components/dialog.md +11 -8
- package/data/llms/tailwind/guides/ai/mcp.md +9 -9
- package/data/llms/tailwind/guides/ai/plugin.md +12 -11
- package/data/manifest.json +46 -46
- package/data/mcp-data.json +4 -4
- package/dist/index.js +1 -1
- package/package.json +7 -3
package/README.md
CHANGED
|
@@ -22,23 +22,23 @@ PrimeReact mode boundaries are preserved through the generated docs data: `style
|
|
|
22
22
|
Run the server with:
|
|
23
23
|
|
|
24
24
|
```bash
|
|
25
|
-
npx -y @primereact/mcp
|
|
25
|
+
npx -y @primereact/mcp
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
The package bundles generated docs from `apps/showcase/public/llms` into `packages/mcp/data`. Generated Markdown and API resources are read from package-owned `data/llms` first, with the local showcase tree used only as a source-development fallback.
|
|
29
29
|
|
|
30
|
-
Package-manager assumption: `@primereact/mcp` does not vendor the shared core. Its RC dependency on `@primeuix/mcp` is pinned exactly to `2.0.0-rc.
|
|
30
|
+
Package-manager assumption: `@primereact/mcp` does not vendor the shared core. Its RC dependency on `@primeuix/mcp` is pinned exactly to `2.0.0-rc.2`; keep the dependency exact throughout the RC cycle so installed behavior remains reproducible.
|
|
31
31
|
|
|
32
32
|
## Claude Code
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
|
-
claude mcp add primereact -s user -- npx -y @primereact/mcp
|
|
35
|
+
claude mcp add primereact -s user -- npx -y @primereact/mcp
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
Project-local install:
|
|
39
39
|
|
|
40
40
|
```bash
|
|
41
|
-
claude mcp add primereact -- npx -y @primereact/mcp
|
|
41
|
+
claude mcp add primereact -- npx -y @primereact/mcp
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
## Cursor
|
|
@@ -50,7 +50,7 @@ Create `.cursor/mcp.json` in your project or `~/.cursor/mcp.json` globally:
|
|
|
50
50
|
"mcpServers": {
|
|
51
51
|
"primereact": {
|
|
52
52
|
"command": "npx",
|
|
53
|
-
"args": ["-y", "@primereact/mcp
|
|
53
|
+
"args": ["-y", "@primereact/mcp"]
|
|
54
54
|
}
|
|
55
55
|
}
|
|
56
56
|
}
|
|
@@ -65,7 +65,7 @@ Create `.vscode/mcp.json` in your project:
|
|
|
65
65
|
"servers": {
|
|
66
66
|
"primereact": {
|
|
67
67
|
"command": "npx",
|
|
68
|
-
"args": ["-y", "@primereact/mcp
|
|
68
|
+
"args": ["-y", "@primereact/mcp"]
|
|
69
69
|
}
|
|
70
70
|
}
|
|
71
71
|
}
|
|
@@ -76,7 +76,7 @@ For a user-level setup, place the same `servers` object in your VS Code MCP user
|
|
|
76
76
|
## Codex
|
|
77
77
|
|
|
78
78
|
```bash
|
|
79
|
-
codex mcp add primereact -- npx -y @primereact/mcp
|
|
79
|
+
codex mcp add primereact -- npx -y @primereact/mcp
|
|
80
80
|
```
|
|
81
81
|
|
|
82
82
|
Direct `~/.codex/config.toml` configuration:
|
|
@@ -84,7 +84,7 @@ Direct `~/.codex/config.toml` configuration:
|
|
|
84
84
|
```toml
|
|
85
85
|
[mcp_servers.primereact]
|
|
86
86
|
command = "npx"
|
|
87
|
-
args = ["-y", "@primereact/mcp
|
|
87
|
+
args = ["-y", "@primereact/mcp"]
|
|
88
88
|
```
|
|
89
89
|
|
|
90
90
|
## Development
|
|
@@ -92,5 +92,4 @@ args = ["-y", "@primereact/mcp@rc"]
|
|
|
92
92
|
```bash
|
|
93
93
|
corepack pnpm --filter @primereact/mcp test
|
|
94
94
|
corepack pnpm --filter @primereact/mcp build
|
|
95
|
-
corepack pnpm --filter @primereact/mcp type:check
|
|
96
95
|
```
|
|
@@ -755,7 +755,7 @@
|
|
|
755
755
|
},
|
|
756
756
|
{
|
|
757
757
|
"name": "getItemProps",
|
|
758
|
-
"type": "(value: unknown
|
|
758
|
+
"type": "(value: unknown) => UseCarouselItemProps",
|
|
759
759
|
"default": "",
|
|
760
760
|
"description": "Returns props for an individual carousel item."
|
|
761
761
|
},
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"description": "The original browser event that triggered the change."
|
|
18
18
|
},
|
|
19
19
|
{
|
|
20
|
-
"name": "
|
|
20
|
+
"name": "value",
|
|
21
21
|
"type": "boolean",
|
|
22
22
|
"default": "",
|
|
23
23
|
"description": "The open state of the menu."
|
|
@@ -330,7 +330,7 @@
|
|
|
330
330
|
"description": "The original browser event that triggered the change."
|
|
331
331
|
},
|
|
332
332
|
{
|
|
333
|
-
"name": "
|
|
333
|
+
"name": "value",
|
|
334
334
|
"type": "boolean",
|
|
335
335
|
"default": "",
|
|
336
336
|
"description": "The open state of the submenu."
|
|
@@ -443,7 +443,7 @@
|
|
|
443
443
|
},
|
|
444
444
|
{
|
|
445
445
|
"name": "getInputProps",
|
|
446
|
-
"type": "(options?: { channel?: ColorInputChannel; disabled?: boolean }) => { data-scope: \"inputcolor\"; data-part: \"input\"; type: \"number\" | \"text\"; spellCheck: boolean; autoComplete: \"off\"; disabled: boolean; data-channel: ColorInputChannel; aria-label: ColorInputChannel; min: number; max: number; step: number;
|
|
446
|
+
"type": "(options?: { channel?: ColorInputChannel; disabled?: boolean }) => { data-scope: \"inputcolor\"; data-part: \"input\"; type: \"number\" | \"text\"; spellCheck: boolean; autoComplete: \"off\"; disabled: boolean; data-channel: ColorInputChannel; aria-label: ColorInputChannel; min: number; max: number; step: number; value: string | number; onChange: (event: ChangeEvent<HTMLInputElement>) => void; onBlur: (event: FocusEvent<HTMLInputElement>) => void; onKeyDown: (event: KeyboardEvent<HTMLInputElement>) => void }",
|
|
447
447
|
"default": "",
|
|
448
448
|
"description": "Provides input props for a color channel."
|
|
449
449
|
},
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"description": "The original browser event that triggered the change."
|
|
17
17
|
},
|
|
18
18
|
{
|
|
19
|
-
"name": "
|
|
19
|
+
"name": "value",
|
|
20
20
|
"type": "boolean",
|
|
21
21
|
"default": "",
|
|
22
22
|
"description": "The open state of the menu."
|
|
@@ -1035,7 +1035,7 @@
|
|
|
1035
1035
|
"description": "The original browser event that triggered the change."
|
|
1036
1036
|
},
|
|
1037
1037
|
{
|
|
1038
|
-
"name": "
|
|
1038
|
+
"name": "value",
|
|
1039
1039
|
"type": "boolean",
|
|
1040
1040
|
"default": "",
|
|
1041
1041
|
"description": "The open state of the submenu."
|
|
@@ -4,7 +4,7 @@ Connect AI assistants to PrimeReact component documentation, guides, examples, s
|
|
|
4
4
|
|
|
5
5
|
## Introduction
|
|
6
6
|
|
|
7
|
-
[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) lets AI assistants call external tools. The `@primereact/mcp
|
|
7
|
+
[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) lets AI assistants call external tools. The `@primereact/mcp` package uses those tools to search and read the PrimeReact documentation included with the package.
|
|
8
8
|
|
|
9
9
|
- Find components, guides, examples, setup instructions, and hooks.
|
|
10
10
|
- Read mode-scoped component APIs and documentation sections.
|
|
@@ -15,11 +15,11 @@ The server requires Node.js 22 or newer. It is read-only and does not change you
|
|
|
15
15
|
|
|
16
16
|
## CLI Setup
|
|
17
17
|
|
|
18
|
-
The recommended setup is the [PrimeReact Plugin](./plugin). It installs this MCP server together with the PrimeReact skills for implementation, setup, theming,
|
|
18
|
+
The recommended setup is the [PrimeReact Plugin](./plugin). It installs this MCP server together with the PrimeReact skills for implementation, setup, theming, accessibility, and troubleshooting.
|
|
19
19
|
|
|
20
20
|
```bash
|
|
21
|
-
pnpm dlx @primeui/cli
|
|
22
|
-
pnpm dlx @primeui/cli
|
|
21
|
+
pnpm dlx @primeui/cli plugin install --tool copilot --library primereact
|
|
22
|
+
pnpm dlx @primeui/cli doctor --tool copilot --library primereact
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
Replace `copilot` with `claude`, `codex`, `gemini`, or `cursor` for another supported assistant. Use Manual Setup when you want the MCP server without the plugin skills.
|
|
@@ -31,7 +31,7 @@ Replace `copilot` with `claude`, `codex`, `gemini`, or `cursor` for another supp
|
|
|
31
31
|
Add the server to your user configuration to use it in every project, or omit `-s user` for the current project only.
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
|
-
claude mcp add primereact -s user -- npx -y @primereact/mcp
|
|
34
|
+
claude mcp add primereact -s user -- npx -y @primereact/mcp
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
See the [Claude Code MCP documentation](https://docs.anthropic.com/en/docs/claude-code/mcp) for client-specific options.
|
|
@@ -45,7 +45,7 @@ Create `.vscode/mcp.json` for project-level setup. To use the server across proj
|
|
|
45
45
|
"servers": {
|
|
46
46
|
"primereact": {
|
|
47
47
|
"command": "npx",
|
|
48
|
-
"args": ["-y", "@primereact/mcp
|
|
48
|
+
"args": ["-y", "@primereact/mcp"]
|
|
49
49
|
}
|
|
50
50
|
}
|
|
51
51
|
}
|
|
@@ -58,13 +58,13 @@ See the [VS Code MCP documentation](https://code.visualstudio.com/docs/copilot/c
|
|
|
58
58
|
Add the server with the Codex CLI, or add the same configuration to `~/.codex/config.toml`.
|
|
59
59
|
|
|
60
60
|
```bash
|
|
61
|
-
codex mcp add primereact -- npx -y @primereact/mcp
|
|
61
|
+
codex mcp add primereact -- npx -y @primereact/mcp
|
|
62
62
|
```
|
|
63
63
|
|
|
64
64
|
```toml
|
|
65
65
|
[mcp_servers.primereact]
|
|
66
66
|
command = "npx"
|
|
67
|
-
args = ["-y", "@primereact/mcp
|
|
67
|
+
args = ["-y", "@primereact/mcp"]
|
|
68
68
|
```
|
|
69
69
|
|
|
70
70
|
See the [OpenAI Codex MCP documentation](https://developers.openai.com/codex/mcp/) for more details.
|
|
@@ -78,7 +78,7 @@ Create `.cursor/mcp.json` in your project or `~/.cursor/mcp.json` for global con
|
|
|
78
78
|
"mcpServers": {
|
|
79
79
|
"primereact": {
|
|
80
80
|
"command": "npx",
|
|
81
|
-
"args": ["-y", "@primereact/mcp
|
|
81
|
+
"args": ["-y", "@primereact/mcp"]
|
|
82
82
|
}
|
|
83
83
|
}
|
|
84
84
|
}
|
|
@@ -6,21 +6,21 @@ Install PrimeReact workflow skills and the PrimeReact MCP server in a supported
|
|
|
6
6
|
|
|
7
7
|
The PrimeReact Plugin adds PrimeReact skills and the PrimeReact 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 PrimeReact-specific, mode-aware workflows as well as read the current component documentation.
|
|
8
8
|
|
|
9
|
-
The plugin is published from the [primefaces/primeui-plugins](https://github.com/primefaces/primeui-plugins) repository. Use `@primeui/cli
|
|
9
|
+
The plugin is published from the [primefaces/primeui-plugins](https://github.com/primefaces/primeui-plugins) repository. Use `@primeui/cli` for the same installation flow across supported assistants, or follow the manual setup for your client.
|
|
10
10
|
|
|
11
11
|
## What It Installs
|
|
12
12
|
|
|
13
13
|
Installing the PrimeReact Plugin adds:
|
|
14
14
|
|
|
15
|
-
-
|
|
16
|
-
- The PrimeReact MCP server, configured with `@primereact/mcp
|
|
15
|
+
- Six focused skills covering routing, implementation, setup, theming, accessibility, and troubleshooting.
|
|
16
|
+
- The PrimeReact MCP server, configured with `@primereact/mcp`.
|
|
17
17
|
- The manifest required by the selected assistant.
|
|
18
18
|
|
|
19
19
|
PrimeVue and PrimeNG are separate plugins. Installing this plugin does not change your application or install PrimeReact dependencies in the project.
|
|
20
20
|
|
|
21
21
|
## Skills
|
|
22
22
|
|
|
23
|
-
Each skill covers one type of PrimeReact work. The skills use `@primereact/mcp
|
|
23
|
+
Each skill covers one type of PrimeReact work. The skills use `@primereact/mcp` when they need mode-scoped component APIs, examples, setup guides, hooks, or usage validation.
|
|
24
24
|
|
|
25
25
|
| Skill | Use it for |
|
|
26
26
|
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -29,9 +29,10 @@ Each skill covers one type of PrimeReact work. The skills use `@primereact/mcp@1
|
|
|
29
29
|
| `primereact-setup-installation` | Configure a supported React environment in `styled`, `tailwind`, `primitive`, or `headless` mode. |
|
|
30
30
|
| `primereact-theming-customization` | Work with styled presets and tokens, Tailwind-owned components, primitives, headless markup, or pass-through APIs without mixing modes. |
|
|
31
31
|
| `primereact-accessibility-icons` | Review semantics, keyboard behavior, focus, accessible names, PrimeIcons, and custom icons in the selected mode. |
|
|
32
|
-
| `primereact-migration` | Plan and apply source-backed version or mode changes using current PrimeReact guides. |
|
|
33
32
|
| `primereact-audit-troubleshooting` | Find invalid APIs and troubleshoot components, setup, MCP, plugin, or duplicate configurations. |
|
|
34
33
|
|
|
34
|
+
The current PrimeReact v11 documentation does not provide a supported version migration guide, so the plugin does not advertise a migration workflow.
|
|
35
|
+
|
|
35
36
|
Skill names use the `primereact-` prefix because assistants may keep skills from several plugins in one shared namespace.
|
|
36
37
|
|
|
37
38
|
## How Skills Work
|
|
@@ -50,7 +51,7 @@ After implementation, run the checks required by your project, including type ch
|
|
|
50
51
|
Set `--tool` to the assistant you use. Keep `--library primereact` when you run the command outside a project or from a project that uses more than one PrimeUI library.
|
|
51
52
|
|
|
52
53
|
```bash
|
|
53
|
-
pnpm dlx @primeui/cli
|
|
54
|
+
pnpm dlx @primeui/cli plugin install --tool copilot --library primereact
|
|
54
55
|
```
|
|
55
56
|
|
|
56
57
|
Supported tool values are `claude`, `codex`, `copilot`, `cursor`, and `gemini`. Use `copilot` for GitHub Copilot CLI and VS Code.
|
|
@@ -60,13 +61,13 @@ Supported tool values are `claude`, `codex`, `copilot`, `cursor`, and `gemini`.
|
|
|
60
61
|
Use the same CLI to check the installation, update the plugin, or remove it. Each command applies only to PrimeReact in the selected assistant.
|
|
61
62
|
|
|
62
63
|
```bash
|
|
63
|
-
pnpm dlx @primeui/cli
|
|
64
|
-
pnpm dlx @primeui/cli
|
|
65
|
-
pnpm dlx @primeui/cli
|
|
66
|
-
pnpm dlx @primeui/cli
|
|
64
|
+
pnpm dlx @primeui/cli plugin status --tool copilot --library primereact
|
|
65
|
+
pnpm dlx @primeui/cli plugin update --tool copilot --library primereact
|
|
66
|
+
pnpm dlx @primeui/cli plugin remove --tool copilot --library primereact
|
|
67
|
+
pnpm dlx @primeui/cli doctor --tool copilot --library primereact
|
|
67
68
|
|
|
68
69
|
# Machine-readable diagnostics
|
|
69
|
-
pnpm dlx @primeui/cli
|
|
70
|
+
pnpm dlx @primeui/cli doctor --tool copilot --library primereact --json
|
|
70
71
|
```
|
|
71
72
|
|
|
72
73
|
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.
|