@primereact/mcp 11.0.0-rc.2 → 11.0.0-rc.3

package/data/llms/tailwind/guides/ai/mcp.md

@@ -0,0 +1,113 @@
+# MCP Server
+
+Connect AI assistants to PrimeReact component documentation, guides, examples, setup, and API metadata.
+
+## Introduction
+
+[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) lets AI assistants call external tools. The `@primereact/mcp@11.0.0` package uses those tools to search and read the PrimeReact documentation included with the package.
+
+- Find components, guides, examples, setup instructions, and hooks.
+- Read mode-scoped component APIs and documentation sections.
+- Check component usage against documented properties and callbacks.
+- Return links to the related PrimeReact documentation when available.
+
+The server requires Node.js 22 or newer. It is read-only and does not change your project files or PrimeReact configuration.
+
+## CLI Setup
+
+The recommended setup is the [PrimeReact Plugin](./plugin). It installs this MCP server together with the PrimeReact skills for implementation, setup, theming, migration, and troubleshooting.
+
+```bash
+pnpm dlx @primeui/cli@1.0.0 plugin install --tool copilot --library primereact
+pnpm dlx @primeui/cli@1.0.0 doctor --tool copilot --library primereact
+```
+
+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.
+
+## Manual Setup
+
+### Claude Code
+
+Add the server to your user configuration to use it in every project, or omit `-s user` for the current project only.
+
+```bash
+claude mcp add primereact -s user -- npx -y @primereact/mcp@11.0.0
+```
+
+See the [Claude Code MCP documentation](https://docs.anthropic.com/en/docs/claude-code/mcp) for client-specific options.
+
+### VS Code
+
+Create `.vscode/mcp.json` for project-level setup. To use the server across projects, add the same `servers` entry to your VS Code user MCP configuration.
+
+```json
+{
+    "servers": {
+        "primereact": {
+            "command": "npx",
+            "args": ["-y", "@primereact/mcp@11.0.0"]
+        }
+    }
+}
+```
+
+See the [VS Code MCP documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more details.
+
+### OpenAI Codex
+
+Add the server with the Codex CLI, or add the same configuration to `~/.codex/config.toml`.
+
+```bash
+codex mcp add primereact -- npx -y @primereact/mcp@11.0.0
+```
+
+```toml
+[mcp_servers.primereact]
+command = "npx"
+args = ["-y", "@primereact/mcp@11.0.0"]
+```
+
+See the [OpenAI Codex MCP documentation](https://developers.openai.com/codex/mcp/) for more details.
+
+### Cursor
+
+Create `.cursor/mcp.json` in your project or `~/.cursor/mcp.json` for global configuration.
+
+```json
+{
+    "mcpServers": {
+        "primereact": {
+            "command": "npx",
+            "args": ["-y", "@primereact/mcp@11.0.0"]
+        }
+    }
+}
+```
+
+See the [Cursor MCP documentation](https://docs.cursor.com/context/model-context-protocol) for more details.
+
+## Tools
+
+The PrimeReact MCP server provides eight tools.
+
+| Tool             | Purpose                                                                                   |
+| ---------------- | ----------------------------------------------------------------------------------------- |
+| `list`           | List available components, guides, examples, resources, or modes.                         |
+| `search`         | Search generated component, guide, section, API, hook, and example text.                  |
+| `get_component`  | Read mode-scoped component or hook documentation, API metadata, and available sections.   |
+| `get_guide`      | Read a generated PrimeReact guide and its source metadata.                                |
+| `get_example`    | Return an example from a documented component or hook section.                            |
+| `get_setup`      | Return setup guidance for a supported PrimeReact mode and environment.                    |
+| `validate_usage` | Validate component usage against generated PrimeReact API metadata in one selected mode.  |
+| `version`        | Report the server version and the status of its documentation data, tools, and resources. |
+
+## Data and Validation
+
+The MCP package includes a generated copy of the PrimeReact documentation. This keeps the server usable without a PrimeReact source checkout and makes its answers match the installed package version. Results include a `primeui://primereact` resource URI and, when available, a link to the public documentation.
+
+- The tools do not edit files, install dependencies, or update configuration.
+- Component, setup, example, and validation calls stay in one selected mode: `styled`, `tailwind`, `primitive`, `headless`, or `hooks` where supported.
+- `validate_usage` checks documented API metadata. If the required metadata is unavailable or the mode is ambiguous, it reports that limitation instead of guessing.
+- Run your project type checks, tests, and browser checks after making changes. MCP validation does not replace them.
+
+If you installed the PrimeReact Plugin, do not register the MCP server again with a manual configuration. Run the CLI `doctor` command if the server is missing or appears more than once.

package/data/llms/tailwind/guides/ai/plugin.md

@@ -0,0 +1,138 @@
+# Plugin
+
+Install PrimeReact workflow skills and the PrimeReact MCP server in a supported AI assistant.
+
+## Introduction
+
+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.
+
+The plugin is published from the [primefaces/primeui-plugins](https://github.com/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.
+
+## What It Installs
+
+Installing the PrimeReact Plugin adds:
+
+- Seven skills for PrimeReact implementation, setup, theming, accessibility, migration, and troubleshooting.
+- The PrimeReact MCP server, configured with `@primereact/mcp@11.0.0`.
+- The manifest required by the selected assistant.
+
+PrimeVue and PrimeNG are separate plugins. Installing this plugin does not change your application or install PrimeReact dependencies in the project.
+
+## Skills
+
+Each skill covers one type of PrimeReact work. The skills use `@primereact/mcp@11.0.0` when they need mode-scoped component APIs, examples, setup guides, hooks, or usage validation.
+
+| Skill                                 | Use it for                                                                                                                              |
+| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| `primereact-router`                   | Select the PrimeReact mode and choose the skill that matches the task.                                                                  |
+| `primereact-component-implementation` | Choose and implement components, composition, properties, callbacks, and documented hooks.                                              |
+| `primereact-setup-installation`       | Configure a supported React environment in `styled`, `tailwind`, `primitive`, or `headless` mode.                                       |
+| `primereact-theming-customization`    | Work with styled presets and tokens, Tailwind-owned components, primitives, headless markup, or pass-through APIs without mixing modes. |
+| `primereact-accessibility-icons`      | Review semantics, keyboard behavior, focus, accessible names, PrimeIcons, and custom icons in the selected mode.                        |
+| `primereact-migration`                | Plan and apply source-backed version or mode changes using current PrimeReact guides.                                                   |
+| `primereact-audit-troubleshooting`    | Find invalid APIs and troubleshoot components, setup, MCP, plugin, or duplicate configurations.                                         |
+
+Skill names use the `primereact-` prefix because assistants may keep skills from several plugins in one shared namespace.
+
+## How Skills Work
+
+You do not need to select a skill manually. Describe the PrimeReact task and the router chooses the relevant workflow.
+
+- The router checks that the project uses React and PrimeReact, then selects `styled`, `tailwind`, `primitive`, or `headless` from project evidence. It uses `hooks` only for a documented standalone hook.
+- The selected skill reads only the component or guide information needed for that mode.
+- When component metadata is available, the skill validates the final PrimeReact usage in the same mode.
+- If project evidence is ambiguous or the documentation does not confirm an API, the skill reports the limitation instead of borrowing guidance from another mode.
+
+After implementation, run the checks required by your project, including type checking, tests, browser behavior, accessibility, and visual review where applicable.
+
+## CLI Setup
+
+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.
+
+```bash
+pnpm dlx @primeui/cli@1.0.0 plugin install --tool copilot --library primereact
+```
+
+Supported tool values are `claude`, `codex`, `copilot`, `cursor`, and `gemini`. Use `copilot` for GitHub Copilot CLI and VS Code.
+
+## Lifecycle and Doctor
+
+Use the same CLI to check the installation, update the plugin, or remove it. Each command applies only to PrimeReact in the selected assistant.
+
+```bash
+pnpm dlx @primeui/cli@1.0.0 plugin status --tool copilot --library primereact
+pnpm dlx @primeui/cli@1.0.0 plugin update --tool copilot --library primereact
+pnpm dlx @primeui/cli@1.0.0 plugin remove --tool copilot --library primereact
+pnpm dlx @primeui/cli@1.0.0 doctor --tool copilot --library primereact
+
+# Machine-readable diagnostics
+pnpm dlx @primeui/cli@1.0.0 doctor --tool copilot --library primereact --json
+```
+
+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.
+
+## Manual Setup
+
+### Source
+
+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/primereact` directory after installation.
+
+```bash
+git clone --branch main https://github.com/primefaces/primeui-plugins.git ~/primeui-plugins
+ls ~/primeui-plugins/plugins/primereact
+```
+
+### Claude Code
+
+Add the PrimeUI marketplace, then install only the PrimeReact plugin.
+
+```bash
+claude plugin marketplace add primefaces/primeui-plugins
+claude plugin install primereact@primeui
+claude plugin list --json
+```
+
+### Codex
+
+Add the PrimeUI marketplace, inspect its catalog, then install only the PrimeReact plugin. Use the interactive plugin browser to manage enablement.
+
+```bash
+codex plugin marketplace add primefaces/primeui-plugins
+codex plugin list --available
+codex plugin add primereact@primeui
+codex plugin list
+```
+
+### VS Code Copilot
+
+Install the PrimeReact Plugin through GitHub Copilot CLI. VS Code automatically discovers plugins installed by Copilot CLI, so it does not need a separate plugin configuration.
+
+```bash
+copilot plugin marketplace add primefaces/primeui-plugins
+copilot plugin install primereact@primeui
+```
+
+The installation includes the seven PrimeReact skills and the PrimeReact MCP server. See the [VS Code Agent Plugins](https://code.visualstudio.com/docs/agent-customization/agent-plugins) and [GitHub Copilot CLI Plugins](https://docs.github.com/en/copilot/how-tos/copilot-cli/customize-copilot/plugins-finding-installing) documentation for client-specific details.
+
+### Cursor
+
+For local setup, link the PrimeReact plugin directory into Cursor's local-plugin directory. Restart Cursor or run `Developer: Reload Window` after creating the link.
+
+```bash
+mkdir -p ~/.cursor/plugins/local
+ln -s ~/primeui-plugins/plugins/primereact ~/.cursor/plugins/local/primereact
+```
+
+Use Cursor's Customize screen to manage the plugin, its skills, and its MCP server.
+
+### Gemini CLI
+
+Validate the PrimeReact 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.
+
+```bash
+gemini extensions validate ~/primeui-plugins/plugins/primereact
+gemini extensions install ~/primeui-plugins/plugins/primereact --consent
+gemini extensions list --output-format json
+```
+
+Gemini CLI 0.29.3 requires `experimental.extensionManagement` to be enabled. The installed extension contains the seven PrimeReact skills and the PrimeReact MCP server.

package/data/llms/tailwind/guides/icons/primeicons.md

@@ -95,7 +95,7 @@ export default function ColorDemo() {
 
 ## Spin
 
-Use a spin animation utility like `animate-spin` from Tailwind apply rotation.
+Use the `spin` property to apply a rotation animation to an icon. Alternatively, a spin animation utility such as `animate-spin` from Tailwind can also be used.
 
 ```tsx
 import { Cog } from '@primeicons/react/cog';
@@ -104,8 +104,8 @@ import { Spinner } from '@primeicons/react/spinner';
 export default function SpinDemo() {
     return (
         <div className="flex justify-center gap-4">
-            <Spinner className="animate-spin" size={32} />
-            <Cog className="animate-spin" size={32} />
+            <Spinner spin size={32} />
+            <Cog spin size={32} />
         </div>
     );
 }

package/data/llms/tailwind/guides/installation/astro.md

@@ -57,7 +57,7 @@ PrimeReact Tailwind components are distributed through a shadcn-compatible regis
 Install PrimeReact along with the icon package and the Tailwind utilities the components rely on:
 
 ```bash
-npm install primereact@11.0.0-rc.2 @primeicons/react@8.0.0-rc.1 tailwindcss-primeui tailwind-merge
+npm install primereact @primeicons/react tailwindcss-primeui tailwind-merge
 ```
 
     </DocStep>

package/data/llms/tailwind/guides/installation/nextjs.md

@@ -57,7 +57,7 @@ PrimeReact Tailwind components are distributed through a shadcn-compatible regis
 Install PrimeReact along with the icon package and the Tailwind utilities the components rely on:
 
 ```bash
-npm install primereact@11.0.0-rc.2 @primeicons/react@8.0.0-rc.1 tailwindcss-primeui tailwind-merge
+npm install primereact @primeicons/react tailwindcss-primeui tailwind-merge
 ```
 
     </DocStep>

package/data/llms/tailwind/guides/installation/react-router.md

@@ -57,7 +57,7 @@ PrimeReact Tailwind components are distributed through a shadcn-compatible regis
 Install PrimeReact along with the icon package and the Tailwind utilities the components rely on:
 
 ```bash
-npm install primereact@11.0.0-rc.2 @primeicons/react@8.0.0-rc.1 tailwindcss-primeui tailwind-merge
+npm install primereact @primeicons/react tailwindcss-primeui tailwind-merge
 ```
 
     </DocStep>

package/data/llms/tailwind/guides/installation/tanstack.md

@@ -57,7 +57,7 @@ PrimeReact Tailwind components are distributed through a shadcn-compatible regis
 Install PrimeReact along with the icon package and the Tailwind utilities the components rely on:
 
 ```bash
-npm install primereact@11.0.0-rc.2 @primeicons/react@8.0.0-rc.1 tailwindcss-primeui tailwind-merge
+npm install primereact @primeicons/react tailwindcss-primeui tailwind-merge
 ```
 
     </DocStep>

package/data/llms/tailwind/guides/installation/vite.md

@@ -57,7 +57,7 @@ PrimeReact Tailwind components are distributed through a shadcn-compatible regis
 Install PrimeReact along with the icon package and the Tailwind utilities the components rely on:
 
 ```bash
-npm install primereact@11.0.0-rc.2 @primeicons/react@8.0.0-rc.1 tailwindcss-primeui tailwind-merge
+npm install primereact @primeicons/react tailwindcss-primeui tailwind-merge
 ```
 
     </DocStep>