@primevue/mcp
v5.0.0
Published
Model Context Protocol (MCP) server for PrimeVue component library
Readme
@primevue/mcp
Model Context Protocol (MCP) server for PrimeVue. The package is a thin public wrapper over the shared @primeuix/mcp v2 core and the generated PrimeVue docs artifacts in packages/mcp/data/mcp-data.json and packages/mcp/data/manifest.json.
Requires Node.js 22 or newer. Published runtime data is self-contained: normalized JSON lives once under data/, while offline Markdown and text resources live under data/llms/.
Run
npx -y @primevue/mcpThe public bin command is also available as:
primevue-mcpSetup
Claude Code
claude mcp add primevue -s user -- npx -y @primevue/mcpProject-local configuration:
claude mcp add primevue -- npx -y @primevue/mcpCursor
Create .cursor/mcp.json in your project or edit ~/.cursor/mcp.json:
{
"mcpServers": {
"primevue": {
"command": "npx",
"args": ["-y", "@primevue/mcp"]
}
}
}VS Code
Create .vscode/mcp.json in your project:
{
"servers": {
"primevue": {
"command": "npx",
"args": ["-y", "@primevue/mcp"]
}
}
}For user-level setup, place the same servers object in your VS Code user MCP configuration.
Codex
codex mcp add primevue -- npx -y @primevue/mcpOr edit ~/.codex/config.toml:
[mcp_servers.primevue]
command = "npx"
args = ["-y", "@primevue/mcp"]MCP Surface
The server exposes only the compact shared v2 tool surface:
| Tool | Purpose |
| ---------------- | --------------------------------------------------------------------------- |
| list | List generated components, guides, examples, resources, or modes. |
| search | Search generated component, guide, section, API, and example text. |
| get_component | Read component docs and metadata. |
| get_guide | Read generated guide docs and metadata. |
| get_example | Return one source-backed example from generated component docs. |
| get_setup | Return setup guidance from generated installation docs. |
| validate_usage | Validate component usage against generated API metadata. |
| version | Return server, docs data, tool, resource, and known manual metadata status. |
Generated docs are exposed through resources and templates:
- Static resources:
primeui://primevue/index.json,primeui://primevue/llms.txt,primeui://primevue/llms-full.txt - Resource templates:
component-docs,component-api,example-docs,guide-docs
Workflow prompts:
use_componentbuild_formtheme_componentmigrate_primeuiaudit_component_usage
Data and Release Assumption
@primevue/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.
The bundled package docs are copied from the generated public /llms Markdown files during build:prebuild. The public /llms files remain the canonical web compatibility surface.
Links
License
Licensed under the PrimeUI License - Copyright (c) PrimeTek Informatics
