@primeng/mcp 0.0.1-alpha.1

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.
Files changed (5) hide show
  1. package/LICENSE.md +77 -0
  2. package/README.md +279 -0
  3. package/dist/index.d.mts +2 -0
  4. package/dist/index.mjs +59950 -0
  5. package/package.json +61 -0
package/LICENSE.md ADDED
@@ -0,0 +1,77 @@
1
+ # PRIMENG LICENSES
2
+
3
+ ## PRIMENG COMMUNITY VERSIONS LICENSE
4
+
5
+ The MIT License (MIT)
6
+
7
+ Copyright (c) 2016-2026 PrimeTek
8
+
9
+ Permission is hereby granted, free of charge, to any person obtaining a copy
10
+ of this software and associated documentation files (the "Software"), to deal
11
+ in the Software without restriction, including without limitation the rights
12
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
+ copies of the Software, and to permit persons to whom the Software is
14
+ furnished to do so, subject to the following conditions:
15
+
16
+ The above copyright notice and this permission notice shall be included in
17
+ all copies or substantial portions of the Software.
18
+
19
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25
+ THE SOFTWARE.
26
+
27
+ ## PRIMENG LTS VERSIONS LICENSE (Versions with -lts suffix)
28
+
29
+ THIS LICENSE AGREEMENT (THIS “CLA”) CONTAINS THE TERMS AND CONDITIONS FOR YOUR USE OF “PRIMENG LONG TERM SUPPORT”, A SUITE OF Angular Components (THE “Software”). THIS CLA IS A BINDING AGREEMENT BETWEEN YOU (“Licensee”) AND PrimeTek Bilişim. (“Licensor“); HOWEVER, IF YOU ARE ACTING AS AN AGENT FOR ANOTHER, SUCH AS ON BEHALF OF YOUR EMPLOYER, THEN “YOU” MEANS THE OTHER PERSON. BY INSTALLING, COPYING, USING OR OTHERWISE ACCESSING THE SOFTWARE, YOU AGREE TO BE BOUND BY THESE TERMS AND CONDITIONS.
30
+
31
+ The term “Software” includes all source and object code, in whole and/or part; all printed materials; “online” or electronic documentation; data, data engines, images; updates and upgrades; and anything provided for use with or in conjunction with the Software.
32
+
33
+ ## Summary
34
+
35
+ - Can be used on unlimited sites and servers
36
+ - Source-code cannot be resold or distributed
37
+ - Commercial use allowed
38
+ - Can modify source-code but cannot distribute modifications (derivative works)
39
+
40
+ ## Terms and Conditions
41
+
42
+ 1. **License Grant:** Licensor hereby grants Licensee a Personal, Non-assignable and non-transferable, Commercial, Royalty free, Including the rights to create but not distribute derivative works, Non-exclusive license identified with a unique key stated in section 3, all with accordance with the terms set forth and other legal restrictions set forth in 3rd party software used while running Software.
43
+
44
+ 1. **Limited:** Licensee may use Software for the purpose of:
45
+
46
+ 1. Running Software on Licensee’s Website\[s\] and Server\[s\];
47
+ 2. Allowing 3rd Parties to run Software on Licensee’s Website\[s\] and Server\[s\];
48
+ 3. Publishing Software’s output to Licensee and 3rd Parties;
49
+ 4. Distribute verbatim copies of Software’s output (including compiled binaries);
50
+ 5. Modify Software to suit Licensee’s needs and specifications.
51
+
52
+ 2. **Non Assignable and Non-Transferable:** Licensee may not assign or transfer his rights and duties under this license.
53
+ 3. **Commercial, Royalty Free:** Licensee may use Software for any purpose, including paid-services, without any royalties
54
+ 4. **Including the Right to Create Derivative Works:** Licensee may create derivative works based on Software, including amending Software’s source code, modifying it, integrating it into a larger work or removing portions of Software, as long as no distribution of the derivative works is made
55
+
56
+ 2. **Term & Termination:** The Term of this license shall be until terminated. Licensor may terminate this Agreement, including Licensee’s license in the case where Licensee :
57
+ 1. became insolvent or otherwise entered into any liquidation process; or
58
+ 2. exported The Software to any jurisdiction where licensor may not enforce his rights under this agreements in; or
59
+ 3. Licensee was in breach of any of this license's terms and conditions and such breach was not cured, immediately upon notification; or
60
+ 4. Licensee in breach of any of the terms of clause 2 to this license; or
61
+ 5. Licensee otherwise entered into any arrangement which caused Licensor to be unable to enforce his rights under this License.
62
+ 3. **Payment:** In consideration of the License granted under clause 2, Licensee shall pay Licensor a fee, via credit card or any other mean which Licensor may deem adequate. Failure to perform payment shall construe as material breach of this Agreement. Transaction id of the payment is the unique license key granted to Licensee.
63
+ 4. **Upgrades, Updates and Fixes:** .
64
+
65
+ 1. **Fix:** for the purpose of this license, a fix shall be a minor amendment in The Software, intended to remove bugs or alter minor features which impair the The Software's functionality. A fix shall be marked as a new sub-sub-version number. For example, should Licensee purchase Software under version 1.1.1, an upgrade shall commence under number 1.1.2.
66
+
67
+ 5. **Support:** Software is provided under an AS-IS basis and without any support, updates or maintenance. Nothing in this Agreement shall require Licensor to provide Licensee with support or fixes to any bug, failure, mis-performance or other defect in The Software.
68
+ 6. **Liability:** To the extent permitted under Law, The Software is provided under an AS-IS basis. Licensor shall never, and without any limit, be liable for any damage, cost, expense or any other payment incurred by Licesee as a result of Software’s actions, failure, bugs and/or any other interaction between The Software and Licesee’s end-equipment, computers, other software or any 3rd party, end-equipment, computer or services. Moreover, Licensor shall never be liable for any defect in source code written by Licensee when relying on The Software or using The Software’s source code.
69
+ 7. **Warranty:**
70
+
71
+ 1. **Intellectual Property:** Licensor hereby warrants that The Software does not violate or infringe any 3rd party claims in regards to intellectual property, patents and/or trademarks and that to the best of its knowledge no legal action has been taken against it for any infringement or violation of any 3rd party intellectual property rights.
72
+ 2. **No-Warranty:** The Software is provided without any warranty; Licensor hereby disclaims any warranty that The Software shall be error free, without defects or code which may cause damage to Licensee’s computers or to Licensee, and that Software shall be functional. Licensee shall be solely liable to any damage, defect or loss incurred as a result of operating software and undertake the risks contained in running The Software on License’s Server\[s\] and Website\[s\].
73
+ 3. **Prior Inspection:** Licensee hereby states that he inspected The Software thoroughly and found it satisfactory and adequate to his needs, that it does not interfere with his regular operation and that it does meet the standards and scope of his computer systems and architecture. Licensee found that The Software interacts with his development, website and server environment and that it does not infringe any of End User License Agreement of any software Licensee may use in performing his services. Licensee hereby waives any claims regarding The Software's incompatibility, performance, results and features, and warrants that he inspected the The Software.
74
+
75
+ 8. **No Refunds:** Licensee warrants that he inspected The Software according to clause 7(c) and that it is adequate to his needs. Accordingly, as The Software is intangible goods, Licensee shall not be, ever, entitled to any refund, rebate, compensation or restitution for any reason whatsoever, even if The Software contains material flaws.
76
+ 9. **Indemnification:** Licensee hereby warrants to hold Licensor harmless and indemnify Licensor for any lawsuit brought against it in regards to Licensee’s use of The Software in means that violate, breach or otherwise circumvent this license, Licensor's intellectual property rights or Licensor's title in The Software. Licensor shall promptly notify Licensee in case of such legal action and request Licensee’s consent prior to any settlement in relation to such lawsuit or claim.
77
+ 10. **Governing Law, Jurisdiction:** Licensee hereby agrees not to initiate class-action lawsuits against Licensor in relation to this license and to compensate Licensor for any legal fees, cost or attorney fees should any claim brought by Licensee against Licensor be denied, in part or in full.
package/README.md ADDED
@@ -0,0 +1,279 @@
1
+ # @primeng/mcp
2
+
3
+ Model Context Protocol (MCP) server for PrimeNG component library. Provides AI assistants with comprehensive access to PrimeNG component documentation, props, events, templates, theming, and code examples.
4
+
5
+ ## What is MCP?
6
+
7
+ [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.
8
+
9
+ ## Quick Start
10
+
11
+ The easiest way to use this MCP server is with `npx` - no installation required:
12
+
13
+ ```bash
14
+ npx @primeng/mcp
15
+ ```
16
+
17
+ ## Installation
18
+
19
+ ### Claude Code
20
+
21
+ Add the PrimeNG MCP server using the CLI:
22
+
23
+ ```bash
24
+ # Add to your user config (available in all projects)
25
+ claude mcp add primeng -s user -- npx -y @primeng/mcp
26
+
27
+ # Or add to current project only
28
+ claude mcp add primeng -- npx -y @primeng/mcp
29
+ ```
30
+
31
+ Alternatively, use the JSON format for more control:
32
+
33
+ ```bash
34
+ claude mcp add-json primeng '{"command":"npx","args":["-y","@primeng/mcp"]}' -s user
35
+ ```
36
+
37
+ **Useful commands:**
38
+
39
+ ```bash
40
+ claude mcp list # List all MCP servers
41
+ claude mcp get primeng # Get server details
42
+ claude mcp remove primeng # Remove the server
43
+ ```
44
+
45
+ After adding, start a new Claude Code session and use `/mcp` to verify the connection.
46
+
47
+ > **Reference:** [Claude Code MCP Documentation](https://code.claude.com/docs/en/mcp)
48
+
49
+ ---
50
+
51
+ ### Cursor
52
+
53
+ **Option 1: Project Configuration**
54
+
55
+ Create `.cursor/mcp.json` in your project:
56
+
57
+ ```json
58
+ {
59
+ "mcpServers": {
60
+ "primeng": {
61
+ "command": "npx",
62
+ "args": ["-y", "@primeng/mcp"]
63
+ }
64
+ }
65
+ }
66
+ ```
67
+
68
+ **Option 2: Global Configuration**
69
+
70
+ Create or edit `~/.cursor/mcp.json` in your home directory:
71
+
72
+ ```json
73
+ {
74
+ "mcpServers": {
75
+ "primeng": {
76
+ "command": "npx",
77
+ "args": ["-y", "@primeng/mcp"]
78
+ }
79
+ }
80
+ }
81
+ ```
82
+
83
+ **Option 3: Via Settings UI**
84
+ 1. Go to **Cursor Settings** > **Tools & Integrations**
85
+ 2. Click **New MCP Server**
86
+ 3. Add the configuration above
87
+
88
+ After adding, go to **Settings > MCP** and click the refresh button. The Composer Agent will automatically use PrimeNG tools when relevant.
89
+
90
+ > **Reference:** [Cursor MCP Documentation](https://docs.cursor.com/context/model-context-protocol)
91
+
92
+ ---
93
+
94
+ ### OpenAI Codex CLI
95
+
96
+ **Option 1: Using the CLI**
97
+
98
+ ```bash
99
+ codex mcp add primeng -- npx -y @primeng/mcp
100
+ ```
101
+
102
+ **Option 2: Direct Configuration**
103
+
104
+ Edit `~/.codex/config.toml`:
105
+
106
+ ```toml
107
+ [mcp_servers.primeng]
108
+ command = "npx"
109
+ args = ["-y", "@primeng/mcp"]
110
+ ```
111
+
112
+ After adding, the MCP server will be available in both the Codex CLI and VS Code extension.
113
+
114
+ > **Reference:** [OpenAI Codex MCP Documentation](https://developers.openai.com/codex/mcp/)
115
+
116
+ ---
117
+
118
+ ### Windsurf
119
+
120
+ **Option 1: Via Settings UI**
121
+ 1. Click **Windsurf - Settings** (bottom right) or press `Cmd+Shift+P` / `Ctrl+Shift+P`
122
+ 2. Type "Open Windsurf Settings"
123
+ 3. Navigate to **Cascade** section
124
+ 4. Click **Manage MCPs** > **View raw config**
125
+
126
+ **Option 2: Direct Configuration**
127
+
128
+ Edit `~/.codeium/windsurf/mcp_config.json`:
129
+
130
+ ```json
131
+ {
132
+ "mcpServers": {
133
+ "primeng": {
134
+ "command": "npx",
135
+ "args": ["-y", "@primeng/mcp"]
136
+ }
137
+ }
138
+ }
139
+ ```
140
+
141
+ After adding, the MCP server will be available in Cascade.
142
+
143
+ > **Reference:** [Windsurf MCP Documentation](https://docs.windsurf.com/windsurf/cascade/mcp)
144
+
145
+ ---
146
+
147
+ ### Zed
148
+
149
+ Add to your Zed settings (`~/.config/zed/settings.json` on Linux, `~/Library/Application Support/Zed/settings.json` on macOS):
150
+
151
+ ```json
152
+ {
153
+ "context_servers": {
154
+ "primeng": {
155
+ "command": {
156
+ "path": "npx",
157
+ "args": ["-y", "@primeng/mcp"]
158
+ }
159
+ }
160
+ }
161
+ }
162
+ ```
163
+
164
+ After adding, restart Zed. Check the Agent Panel's settings view - a green indicator dot next to "primeng" confirms the server is active.
165
+
166
+ > **Reference:** [Zed MCP Documentation](https://zed.dev/docs/ai/mcp)
167
+
168
+ ---
169
+
170
+ ## Available Tools
171
+
172
+ ### Component Information
173
+
174
+ | Tool | Description |
175
+ |------|-------------|
176
+ | `list_components` | List all PrimeNG components with categories |
177
+ | `get_component` | Get detailed info about a specific component |
178
+ | `search_components` | Search components by name or description |
179
+ | `get_component_props` | Get all props for a component |
180
+ | `get_component_events` | Get all events for a component |
181
+ | `get_component_methods` | Get all methods for a component |
182
+ | `get_component_slots` | Get all templates for a component |
183
+ | `compare_components` | Compare two components side by side |
184
+ | `get_categories` | Get all component categories |
185
+
186
+ ### Code Examples
187
+
188
+ | Tool | Description |
189
+ |------|-------------|
190
+ | `get_usage_example` | Get code examples for a component |
191
+ | `list_examples` | List all available code examples |
192
+ | `get_example` | Get a specific example by component and section |
193
+ | `generate_component_template` | Generate a basic component template |
194
+
195
+ ### Theming & Styling
196
+
197
+ | Tool | Description |
198
+ |------|-------------|
199
+ | `get_component_pt` | Get Pass Through options for DOM customization |
200
+ | `get_component_tokens` | Get design tokens (CSS variables) |
201
+ | `get_component_styles` | Get CSS class names |
202
+ | `get_theming_info` | Get theming information |
203
+ | `get_theming_guide` | Get detailed theming guide |
204
+ | `get_passthrough_guide` | Get Pass Through customization guide |
205
+ | `get_tailwind_guide` | Get Tailwind CSS integration guide |
206
+
207
+ ### Documentation & Guides
208
+
209
+ | Tool | Description |
210
+ |------|-------------|
211
+ | `list_guides` | List all guides and documentation pages |
212
+ | `get_guide` | Get a specific guide by name |
213
+ | `get_configuration` | Get PrimeNG configuration options |
214
+ | `get_installation` | Get installation instructions |
215
+ | `get_icons_guide` | Get icons usage guide |
216
+ | `get_accessibility_guide` | Get accessibility guide |
217
+ | `get_accessibility_info` | Get accessibility info for a component |
218
+
219
+ ### Migration
220
+
221
+ | Tool | Description |
222
+ |------|-------------|
223
+ | `get_migration_guide` | Get migration guide overview |
224
+ | `migrate_v18_to_v19` | v18 to v19 migration guide |
225
+ | `migrate_v19_to_v20` | v19 to v20 migration guide |
226
+ | `migrate_v20_to_v21` | v20 to v21 migration guide |
227
+
228
+ ### Search & Discovery
229
+
230
+ | Tool | Description |
231
+ |------|-------------|
232
+ | `search_all` | Search across components, guides, and props |
233
+ | `suggest_component` | Suggest components based on use case |
234
+ | `find_by_prop` | Find components with a specific prop |
235
+ | `find_by_event` | Find components that emit a specific event |
236
+ | `find_components_with_feature` | Find components supporting a feature |
237
+ | `get_related_components` | Find related components |
238
+
239
+ ### Utilities
240
+
241
+ | Tool | Description |
242
+ |------|-------------|
243
+ | `get_component_url` | Get the official documentation URL |
244
+ | `get_component_import` | Get the correct import statement |
245
+ | `get_component_sections` | Get all sections/features for a component |
246
+ | `validate_props` | Validate props for a component |
247
+ | `export_component_docs` | Export documentation in markdown |
248
+ | `get_form_components` | Get all form input components |
249
+ | `get_data_components` | Get all data display components |
250
+ | `get_overlay_components` | Get all overlay/popup components |
251
+ | `get_performance_tips` | Get performance optimization tips |
252
+ | `get_version_info` | Get version and compatibility info |
253
+
254
+ ## Example Prompts
255
+
256
+ Once installed, try asking your AI assistant:
257
+
258
+ - "Show me how to use the DataTable component with sorting and filtering"
259
+ - "What props does the Button component have?"
260
+ - "How do I customize the Dialog component styling with Pass Through?"
261
+ - "Compare the Select and Listbox components"
262
+ - "What's the best component for a date picker?"
263
+ - "How do I migrate from PrimeNG v20 to v21?"
264
+
265
+ ## Requirements
266
+
267
+ - Node.js 18+
268
+ - One of the supported AI tools (Claude Code, Cursor, OpenAI Codex, Windsurf, Zed)
269
+
270
+ ## Links
271
+
272
+ - [PrimeNG Documentation](https://primeng.org/)
273
+ - [Model Context Protocol](https://modelcontextprotocol.io/)
274
+ - [GitHub Repository](https://github.com/primefaces/primeng)
275
+ - [Report Issues](https://github.com/primefaces/primeng/issues)
276
+
277
+ ## License
278
+
279
+ MIT
package/dist/index.d.mts ADDED
@@ -0,0 +1,2 @@
1
+
2
+ export { }