@primeng/mcp 0.0.1-alpha.1 → 21.0.1

package/README.md

@@ -6,14 +6,6 @@ Model Context Protocol (MCP) server for PrimeNG component library. Provides AI a
 
 [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that enables AI models to connect with external tools and data sources. By installing this MCP server, your AI assistant gains deep knowledge of PrimeNG components and can provide accurate, up-to-date information while helping you build Angular applications.
 
-## Quick Start
-
-The easiest way to use this MCP server is with `npx` - no installation required:
-
-```bash
-npx @primeng/mcp
-```
-
 ## Installation
 
 ### Claude Code
@@ -48,6 +40,44 @@ After adding, start a new Claude Code session and use `/mcp` to verify the conne
 
 ---
 
+### VS Code
+
+**Option 1: Project Configuration**
+
+Create `.vscode/mcp.json` in your project:
+
+```json
+{
+    "servers": {
+        "primeng": {
+            "command": "npx",
+            "args": ["-y", "@primeng/mcp"]
+        }
+    }
+}
+```
+
+**Option 2: Global Configuration**
+
+Create or edit `~/Library/Application Support/Code/User/mcp.json` (macOS) or `~/.config/Code/User/mcp.json` (Linux):
+
+```json
+{
+    "servers": {
+        "primeng": {
+            "command": "npx",
+            "args": ["-y", "@primeng/mcp"]
+        }
+    }
+}
+```
+
+After adding, the MCP server will be available in GitHub Copilot Chat.
+
+> **Reference:** [VS Code MCP Documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
+
+---
+
 ### Cursor
 
 **Option 1: Project Configuration**

package/dist/{index.mjs → index.js}

@@ -6,7 +6,7 @@ import { runPrimeMcpServer } from "@primeuix/mcp";
 // data/components.json
 var components_default = {
   version: "1.0.0",
-  generatedAt: "2025-12-10",
+  generatedAt: "2025-12-15",
   components: [
     {
       name: "accordion",
@@ -654,7 +654,7 @@ var components_default = {
     {
       name: "animateonscroll",
       title: "Angular Animate On Scroll Directive",
-      description: "AnimateOnScroll AnimateOnScroll is used to apply animations to elements when entering or leaving the viewport during scrolling.",
+      description: "AnimateOnScroll is used to apply animations to elements when entering or leaving the viewport during scrolling.",
       sections: [
         {
           id: "accessibility",
@@ -24596,6 +24596,91 @@ export class InputTextDisabledDemo {
         tokens: null
       }
     },
+    {
+      name: "mcp",
+      title: "MCP Server - PrimeNG",
+      description: "Model Context Protocol (MCP) server for PrimeNG component library. Provides AI assistants with comprehensive access to PrimeNG component documentation.",
+      sections: [
+        {
+          id: "claudecode",
+          label: "Claude Code",
+          description: "Add the PrimeNG MCP server using the CLI. After adding, start a new session and use /mcp to verify the connection.",
+          examples: null
+        },
+        {
+          id: "cursor",
+          label: "Cursor",
+          description: "Create .cursor/mcp.json in your project or ~/.cursor/mcp.json for global configuration.",
+          examples: {
+            basic: '{\n    "mcpServers": {\n        "primeng": {\n            "command": "npx",\n            "args": ["-y", "@primeng/mcp"]\n        }\n    }\n}'
+          }
+        },
+        {
+          id: "exampleprompts",
+          label: "examplepromptsdoc",
+          description: "Once installed, try asking your AI assistant:",
+          examples: {
+            basic: `"Show me how to use the Table component with sorting and filtering"
+"What props does the Button component have?"
+"How do I customize the Dialog component styling with Pass Through?"
+"Compare the Select and Listbox components"
+"What's the best component for a date picker?"
+"How do I migrate from PrimeNG v20 to v21?"`
+          }
+        },
+        {
+          id: "introduction",
+          label: "Introduction",
+          description: "Model Context Protocol (MCP) is an open standard that enables AI models to connect with external tools and data sources . The PrimeNG MCP server provides AI assistants with comprehensive access to: Component documentation including props , events , templates , and methods Theming and styling with Pass Through and design tokens Code examples and usage patterns Migration guides for version upgrades Installation and configuration guides",
+          examples: null
+        },
+        {
+          id: "openaicodex",
+          label: "OpenAI Codex",
+          description: "Add the PrimeNG MCP server using the CLI or edit ~/.codex/config.toml directly.",
+          examples: null
+        },
+        {
+          id: "tools",
+          label: "Available Tools",
+          description: "Component Information Tools for exploring and understanding PrimeNG components. list_components : List all PrimeNG components with categories get_component : Get detailed info about a specific component search_components : Search components by name or description get_component_props : Get all props for a component get_component_events : Get all events for a component get_component_methods : Get all methods for a component get_component_slots : Get all templates for a component compare_components : Compare two components side by side Code Examples Tools for retrieving code samples and generating templates. get_usage_example : Get code examples for a component list_examples : List all available code examples get_example : Get a specific example by component and section generate_component_template : Generate a basic component template Theming & Styling Tools for customizing component appearance and styling. get_component_pt : Get Pass Through options for DOM customization get_component_tokens : Get design tokens (CSS variables) get_component_styles : Get CSS class names get_theming_guide : Get detailed theming guide get_passthrough_guide : Get Pass Through customization guide get_tailwind_guide : Get Tailwind CSS integration guide Documentation & Guides Tools for accessing PrimeNG documentation and guides. list_guides : List all guides and documentation pages get_guide : Get a specific guide by name get_configuration : Get PrimeNG configuration options get_installation : Get installation instructions get_accessibility_guide : Get accessibility guide get_accessibility_info : Get accessibility info for a component Migration Tools for upgrading between PrimeNG versions. get_migration_guide : Get migration guide overview migrate_v18_to_v19 : v18 to v19 migration guide migrate_v19_to_v20 : v19 to v20 migration guide migrate_v20_to_v21 : v20 to v21 migration guide Search & Discovery Tools for finding components based on various criteria. search_all : Search across components, guides, and props suggest_component : Suggest components based on use case find_by_prop : Find components with a specific prop find_by_event : Find components that emit a specific event find_components_with_feature : Find components supporting a feature get_related_components : Find related components",
+          examples: null
+        },
+        {
+          id: "vscode",
+          label: "VS Code",
+          description: "Create .vscode/mcp.json in your project or ~/Library/Application Support/Code/User/mcp.json for global configuration.",
+          examples: {
+            basic: '{\n    "servers": {\n        "primeng": {\n            "command": "npx",\n            "args": ["-y", "@primeng/mcp"]\n        }\n    }\n}'
+          }
+        },
+        {
+          id: "windsurf",
+          label: "Windsurf",
+          description: "Edit ~/.codeium/windsurf/mcp_config.json to add the PrimeNG MCP server.",
+          examples: {
+            basic: '{\n    "mcpServers": {\n        "primeng": {\n            "command": "npx",\n            "args": ["-y", "@primeng/mcp"]\n        }\n    }\n}'
+          }
+        },
+        {
+          id: "zed",
+          label: "Zed",
+          description: "Add to your Zed settings at ~/.config/zed/settings.json (Linux) or ~/Library/Application Support/Zed/settings.json (macOS).",
+          examples: {
+            basic: '{\n    "context_servers": {\n        "primeng": {\n            "command": {\n                "path": "npx",\n                "args": ["-y", "@primeng/mcp"]\n            }\n        }\n    }\n}'
+          }
+        }
+      ],
+      api: {
+        props: null,
+        templates: null,
+        emits: null,
+        methods: null,
+        pt: null,
+        styles: null,
+        tokens: null
+      }
+    },
     {
       name: "megamenu",
       title: "Angular MegaMenu Component",
@@ -59473,6 +59558,83 @@ export class PanelPtDemo {
         }
       ]
     },
+    {
+      name: "mcp",
+      path: "mcp",
+      title: "MCP Server",
+      description: "Model Context Protocol (MCP) server for PrimeNG component library.",
+      sections: [
+        {
+          id: "claudecode",
+          label: "Claudecode",
+          description: "Add the PrimeNG MCP server using the CLI. After adding, start a new session and use /mcp to verify the connection.",
+          examples: null
+        },
+        {
+          id: "cursor",
+          label: "Cursor",
+          description: "Create .cursor/mcp.json in your project or ~/.cursor/mcp.json for global configuration.",
+          examples: {
+            basic: '{\n    "mcpServers": {\n        "primeng": {\n            "command": "npx",\n            "args": ["-y", "@primeng/mcp"]\n        }\n    }\n}'
+          }
+        },
+        {
+          id: "exampleprompts",
+          label: "Exampleprompts",
+          description: "Once installed, try asking your AI assistant:",
+          examples: {
+            basic: `"Show me how to use the Table component with sorting and filtering"
+"What props does the Button component have?"
+"How do I customize the Dialog component styling with Pass Through?"
+"Compare the Select and Listbox components"
+"What's the best component for a date picker?"
+"How do I migrate from PrimeNG v20 to v21?"`
+          }
+        },
+        {
+          id: "introduction",
+          label: "Introduction",
+          description: "Model Context Protocol (MCP) is an open standard that enables AI models to connect with external tools and data sources . The PrimeNG MCP server provides AI assistants with comprehensive access to: Component documentation including props , events , templates , and methods Theming and styling with Pass Through and design tokens Code examples and usage patterns Migration guides for version upgrades Installation and configuration guides",
+          examples: null
+        },
+        {
+          id: "openaicodex",
+          label: "Openaicodex",
+          description: "Add the PrimeNG MCP server using the CLI or edit ~/.codex/config.toml directly.",
+          examples: null
+        },
+        {
+          id: "tools",
+          label: "Tools",
+          description: "Component Information Tools for exploring and understanding PrimeNG components. list_components : List all PrimeNG components with categories get_component : Get detailed info about a specific component search_components : Search components by name or description get_component_props : Get all props for a component get_component_events : Get all events for a component get_component_methods : Get all methods for a component get_component_slots : Get all templates for a component compare_components : Compare two components side by side Code Examples Tools for retrieving code samples and generating templates. get_usage_example : Get code examples for a component list_examples : List all available code examples get_example : Get a specific example by component and section generate_component_template : Generate a basic component template Theming & Styling Tools for customizing component appearance and styling. get_component_pt : Get Pass Through options for DOM customization get_component_tokens : Get design tokens (CSS variables) get_component_styles : Get CSS class names get_theming_guide : Get detailed theming guide get_passthrough_guide : Get Pass Through customization guide get_tailwind_guide : Get Tailwind CSS integration guide Documentation & Guides Tools for accessing PrimeNG documentation and guides. list_guides : List all guides and documentation pages get_guide : Get a specific guide by name get_configuration : Get PrimeNG configuration options get_installation : Get installation instructions get_accessibility_guide : Get accessibility guide get_accessibility_info : Get accessibility info for a component Migration Tools for upgrading between PrimeNG versions. get_migration_guide : Get migration guide overview migrate_v18_to_v19 : v18 to v19 migration guide migrate_v19_to_v20 : v19 to v20 migration guide migrate_v20_to_v21 : v20 to v21 migration guide Search & Discovery Tools for finding components based on various criteria. search_all : Search across components, guides, and props suggest_component : Suggest components based on use case find_by_prop : Find components with a specific prop find_by_event : Find components that emit a specific event find_components_with_feature : Find components supporting a feature get_related_components : Find related components",
+          examples: null
+        },
+        {
+          id: "vscode",
+          label: "Vscode",
+          description: "Create .vscode/mcp.json in your project or ~/Library/Application Support/Code/User/mcp.json for global configuration.",
+          examples: {
+            basic: '{\n    "servers": {\n        "primeng": {\n            "command": "npx",\n            "args": ["-y", "@primeng/mcp"]\n        }\n    }\n}'
+          }
+        },
+        {
+          id: "windsurf",
+          label: "Windsurf",
+          description: "Edit ~/.codeium/windsurf/mcp_config.json to add the PrimeNG MCP server.",
+          examples: {
+            basic: '{\n    "mcpServers": {\n        "primeng": {\n            "command": "npx",\n            "args": ["-y", "@primeng/mcp"]\n        }\n    }\n}'
+          }
+        },
+        {
+          id: "zed",
+          label: "Zed",
+          description: "Add to your Zed settings at ~/.config/zed/settings.json (Linux) or ~/Library/Application Support/Zed/settings.json (macOS).",
+          examples: {
+            basic: '{\n    "context_servers": {\n        "primeng": {\n            "command": {\n                "path": "npx",\n                "args": ["-y", "@primeng/mcp"]\n            }\n        }\n    }\n}'
+          }
+        }
+      ]
+    },
     {
       name: "accessibility",
       path: "guides/accessibility",
@@ -59697,11 +59859,11 @@ export class PanelPtDemo {
 // package.json
 var package_default = {
   name: "@primeng/mcp",
-  version: "0.0.1-alpha.1",
+  version: "21.0.1",
   author: "PrimeTek Informatics",
   description: "Model Context Protocol (MCP) server for PrimeNg component library",
   homepage: "https://primeng.org/",
-  license: "MIT",
+  license: "SEE LICENSE IN LICENSE.md",
   repository: {
     type: "git",
     url: "https://github.com/primefaces/primeng.git",
@@ -59720,16 +59882,17 @@ var package_default = {
     "components"
   ],
   bin: {
-    "primeng-mcp": "./dist/index.mjs"
+    "primeng-mcp": "./dist/index.js"
   },
-  main: "./dist/index.mjs",
-  module: "./dist/index.mjs",
-  types: "./dist/index.d.mts",
+  type: "module",
+  main: "./dist/index.js",
+  module: "./dist/index.js",
+  types: "./dist/index.d.ts",
   exports: {
     ".": {
-      types: "./dist/index.d.mts",
-      import: "./dist/index.mjs",
-      default: "./dist/index.mjs"
+      types: "./dist/index.d.ts",
+      import: "./dist/index.js",
+      default: "./dist/index.js"
     }
   },
   publishConfig: {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@primeng/mcp",
-  "version": "0.0.1-alpha.1",
+  "version": "21.0.1",
   "author": "PrimeTek Informatics",
   "description": "Model Context Protocol (MCP) server for PrimeNg component library",
   "homepage": "https://primeng.org/",
-  "license": "MIT",
+  "license": "SEE LICENSE IN LICENSE.md",
   "repository": {
     "type": "git",
     "url": "https://github.com/primefaces/primeng.git",
@@ -23,16 +23,17 @@
     "components"
   ],
   "bin": {
-    "primeng-mcp": "./dist/index.mjs"
+    "primeng-mcp": "./dist/index.js"
   },
-  "main": "./dist/index.mjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.mts",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.mts",
-      "import": "./dist/index.mjs",
-      "default": "./dist/index.mjs"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
     }
   },
   "publishConfig": {
@@ -44,7 +45,7 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@primeuix/mcp": "^0.0.1-alpha.2"
+    "@primeuix/mcp": "^1.0.0"
   },
   "devDependencies": {
     "tsup": "^8.1.0"