@primeng/mcp
v22.1.5
Published
Model Context Protocol (MCP) server for PrimeNg component library
Readme
@primeng/mcp
Model Context Protocol server for PrimeNG documentation. The public command is:
npx -y @primeng/mcpThe package also exposes the primeng-mcp bin when installed globally or through a package manager.
Setup
Claude Code
claude mcp add primeng -s user -- npx -y @primeng/mcpProject-only setup:
claude mcp add primeng -- npx -y @primeng/mcpCursor
Add .cursor/mcp.json in a project or edit ~/.cursor/mcp.json:
{
"mcpServers": {
"primeng": {
"command": "npx",
"args": ["-y", "@primeng/mcp"]
}
}
}VS Code
Add .vscode/mcp.json in a project or configure the same server globally:
{
"servers": {
"primeng": {
"command": "npx",
"args": ["-y", "@primeng/mcp"]
}
}
}Codex
codex mcp add primeng -- npx -y @primeng/mcpOr add it to ~/.codex/config.toml:
[mcp_servers.primeng]
command = "npx"
args = ["-y", "@primeng/mcp"]Tool Surface
This package is a thin PrimeNG wrapper over the shared @primeuix/mcp v2 core. It exposes only the compact v2 tools:
| Tool | Purpose |
| --- | --- |
| list | List generated components, guides, resources, examples, or modes. |
| search | Search generated PrimeNG docs and API metadata. |
| get_component | Read component docs and metadata. |
| get_guide | Read generated guide docs. |
| get_example | Return one source-backed component example. |
| get_setup | Return source-backed setup or installation guidance. |
| validate_usage | Validate component usage against generated API metadata. |
| version | Return server, data, resource, diagnostics, and prompt metadata. |
The old broad per-field tools are not exposed by this package.
Resources and Prompts
The server registers PrimeNG docs resources from the package-owned data/mcp-data.json and data/manifest.json artifacts. Build preflight copies the generated public /llms Markdown into data/llms; the published runtime never falls back to a showcase checkout.
Static resources:
primeui://primeng/index.jsonprimeui://primeng/llms.txtprimeui://primeng/llms-full.txt
Resource templates:
component-docscomponent-apiexample-docsguide-docs
Prompts:
audit_component_usagebuild_formmigrate_primeuitheme_componentuse_component
The public /llms Markdown files remain the source documents for component and guide Markdown resources.
Package-Manager Assumption
@primeng/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.
Links
License
Licensed under the PrimeUI License - Copyright (c) PrimeTek Informatics
