You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/en/components/ai/cli-mcp.md
+47-13Lines changed: 47 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,32 +1,32 @@
1
1
---
2
-
title: Angular Ignite UI CLI MCP | Infragistics
3
-
_description: Connect Ignite UI CLI MCP to your AI client to scaffold projects, modify existing apps, create and update components, and ask documentation questions for Ignite UI for Angular. Learn the setup options for VS Code, GitHub, Cursor, Claude Desktop, Claude Code, JetBrains, and other MCP clients.
<pclass="highlight">The Ignite UI CLI MCP is a <ahref="https://modelcontextprotocol.io/"target="_blank">Model Context Protocol</a> (MCP) server that enables AI assistants to scaffold projects, modify existing apps, create and update components, and answer documentation questions for Ignite UI for Angular applications. Connect the Ignite UI CLI MCP to your editor, GitHub repository, or desktop AI client and describe what you want - the assistant uses the CLI tools for you.</p>
17
+
<pclass="highlight">The Ignite UI CLI MCP is a <ahref="https://modelcontextprotocol.io/"target="_blank">Model Context Protocol</a> (MCP) server that enables AI assistants to scaffold projects, modify existing apps, create and update components, and answer documentation questions for {ProductName} applications. Connect the Ignite UI CLI MCP to your editor, GitHub repository, or desktop AI client and describe what you want - the assistant uses the CLI tools for you.</p>
18
18
19
19
<divclass="divider"></div>
20
20
21
21
## Overview
22
22
23
-
Ignite UI CLI MCP gives AI assistants direct access to Ignite UI CLI project scaffolding, component generation, project modification, and documentation-aware workflows through chat or agent mode. The server works alongside Ignite UI Theming MCP - CLI MCP handles project and component workflows while Theming MCP handles palettes, themes, tokens, and styling. Most teams connect both servers in the same AI client session.
23
+
Ignite UI CLI MCP gives AI assistants direct access to Ignite UI CLI project scaffolding, component generation, project modification, and documentation-aware workflows through chat or agent mode. The server works alongside [Ignite UI Theming MCP](./theming-mcp.md). CLI MCP handles project and component workflows while Theming MCP handles palettes, themes, tokens, and styling. Most teams connect both servers in the same AI client session.
24
24
25
25
The recommended setup path is to start with Ignite UI CLI first. That path creates the project, installs the required packages, and writes the initial MCP configuration for VS Code. You can also start from an empty folder and let the assistant create the project through MCP, or connect MCP to a project that already exists.
26
26
27
27
**Example prompts to try once connected:**
28
28
29
-
> _"Create a new Ignite UI for Angular project in this folder, use the recommended defaults, and add a starter dashboard page with sample data."_
29
+
> _"Create a new {ProductName} project in this folder, use the recommended defaults, and add a starter dashboard page with sample data."_
30
30
31
31
> _"Add a new grid page to this project, wire it to sample data, and keep the current navigation structure."_
32
32
@@ -44,7 +44,7 @@ Before configuring the MCP server, make sure you have:
44
44
- One of the following starting points:
45
45
- an empty folder for a new project
46
46
- a project you created with Ignite UI CLI
47
-
- an existing Ignite UI for Angular project you want to continue working on
47
+
- an existing {ProductName} project you want to continue working on
48
48
49
49
If you want theming tools in the same client session and `igniteui-theming` is not already available in your project, run:
50
50
@@ -120,19 +120,53 @@ npx --package igniteui-cli igniteui new
120
120
121
121
Use a direct command when you already know the project settings:
122
122
123
+
<!-- Angular -->
124
+
123
125
```bash
124
126
ig new my-app --framework=angular --type=igx-ts --template=empty
125
127
```
126
128
127
129
Matching `npx` form:
128
130
129
131
```bash
130
-
npx --package igniteui-cli igniteui new my-app --framework=angular --type=igx-ts --template=empty
132
+
npx ig new my-app --framework=angular --type=igx-ts --template=empty
133
+
```
134
+
135
+
<!-- end: Angular -->
136
+
137
+
<!-- React -->
138
+
139
+
```bash
140
+
ig new my-app --framework=react --type=igr-ts --template=top-nav
141
+
```
142
+
143
+
Matching `npx` form:
144
+
145
+
```bash
146
+
npx ig new my-app --framework=react --template=top-nav
131
147
```
132
148
149
+
<!-- end: React -->
150
+
151
+
<!-- WebComponents -->
152
+
153
+
```bash
154
+
ig new my-app --framework=webcomponents --template=side-nav
155
+
```
156
+
157
+
Matching `npx` form:
158
+
159
+
```bash
160
+
npx ig new my-app --framework=webcomponents --template=side-nav
161
+
```
162
+
163
+
<!-- end: WebComponents -->
164
+
133
165
In guided mode, Ignite UI CLI prompts for the project name, framework, template, theme, and whether to add a component or complete the setup. In direct mode, you provide the framework and any supported options in the command itself.
134
166
135
-
For more details about project templates, CLI command options, and component scaffolding commands such as `ig add`, see the Ignite UI CLI documentation for Angular.
167
+
<!-- React, WebComponents -->
168
+
For more details about project templates, CLI command options, and component scaffolding commands such as `ig add`, see the [Ignite UI CLI documentation](../general-cli-overview.md).
169
+
<!-- end: React, WebComponents -->
136
170
137
171
### VS Code
138
172
@@ -410,12 +444,12 @@ Validate that the JSON uses the `mcpServers` structure and that each local serve
410
444
## Additional Resources
411
445
412
446
-[AI-Assisted Development with Ignite UI](./ai-assisted-development-overview.md)
413
-
-[Ignite UI for Angular Skills](./skills.md)
447
+
-[{ProductName} Skills](./skills.md)
414
448
-[Ignite UI Theming MCP](./theming-mcp.md)
415
449
416
450
<divclass="divider--half"></div>
417
451
418
452
Our community is active and always welcoming to new ideas.
419
453
420
-
-[Ignite UI for Angular **Forums**](https://www.infragistics.com/community/forums/f/ignite-ui-for-angular)
421
-
-[Ignite UI for Angular **GitHub**](https://github.com/IgniteUI/igniteui-angular)
{ProductName} ships with **[Agent Skills](https://agentskills.io/)** - structured knowledge files that teach AI coding assistants (GitHub Copilot, Cursor, Windsurf, Claude, Gemini CLI, JetBrains Junie, etc.) how to work with {ProductName}. These skill files provide context-aware guidance on components, grids, data operations, and theming, enabling your AI assistant to generate accurate, idiomatic code that follows best practices.
@@ -24,7 +27,7 @@ The skill files live in the [`skills/`]({GithubLink}/tree/master/skills) directo
| Platform Integration |[`skills/igniteui-wc-integrate-with-framework/SKILL.md`]({GithubLink}/blob/master/skills/igniteui-wc-integrate-with-framework/SKILL.md)| Helps with integrating components to the user's platform of choice |
| Optimization | [`skills/igniteui-wc-optimize-bundle-size/SKILL.md`]({GithubLink}/blob/master/skills/igniteui-wc-optimize-bundle-size/SKILL.md) | Ensuring best practices for tree shaking to optimize bundle size
30
+
| Optimization |[`skills/igniteui-wc-optimize-bundle-size/SKILL.md`]({GithubLink}/blob/master/skills/igniteui-wc-optimize-bundle-size/SKILL.md)| Ensuring best practices for tree shaking to optimize bundle size|
28
31
29
32
<!-- end: WebComponents -->
30
33
@@ -34,7 +37,7 @@ The skill files live in the [`skills/`]({GithubLink}/tree/master/skills) directo
34
37
|:------|:-----|:------------|
35
38
| Components |[`skills/igniteui-react-components/SKILL.md`]({GithubLink}/blob/master/skills/igniteui-react-components/SKILL.md)| Identify the right components, install, import, and use them - JSX patterns, event handling, refs, forms, TypeScript |
| Optimization | [`skills/igniteui-react-optimize-bundle-size/SKILL.md`]({GithubLink}/blob/master/skills/igniteui-react-optimize-bundle-size/SKILL.md) | Ensuring best practices for tree shaking to optimize bundle size
40
+
| Optimization |[`skills/igniteui-react-optimize-bundle-size/SKILL.md`]({GithubLink}/blob/master/skills/igniteui-react-optimize-bundle-size/SKILL.md)| Ensuring best practices for tree shaking to optimize bundle size|
38
41
39
42
<!-- end: React -->
40
43
@@ -117,7 +120,7 @@ For user-level (global) skills available across all projects, use `~/.agents/ski
117
120
| Project |`.github/skills/`, `.claude/skills/`|
118
121
| Personal |`~/.copilot/skills/`, `~/.claude/skills/` (Copilot coding agent and GitHub Copilot CLI only) |
119
122
120
-
> **Tip:** In [VS Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), these locations also include the general `.agents/skills/` and `~/.agents/skills/` and you can configure additional skill locations using the `chat.agentSkillsLocations` setting.
123
+
> **Tip:** In [VS Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), these locations also include the general `.agents/skills/` and `~/.agents/skills/` and you can configure additional skill locations using the `chat.agentSkillsLocations` setting.
121
124
122
125
### Claude
123
126
@@ -174,7 +177,7 @@ Use one of the options below to download and place the skill files into the appr
174
177
175
178
### **Option A - Use the Ignite UI CLI**
176
179
177
-
The `ai-config` command copies skill files from your installed {ProductName} package into `.claude/skills/` and writes the Ignite UI MCP server configuration to `.vscode/mcp.json`. If the files already exist and are up-to-date, the command is a no-op.
180
+
The `ai-config` command copies skill files from your installed {ProductName} package into `.claude/skills/` and writes the Ignite UI CLI MCP and Theming MCP server entries to `.vscode/mcp.json`. If the files already exist and are up-to-date, the command is a no-op.
178
181
179
182
<!-- Angular -->
180
183
@@ -189,16 +192,18 @@ This also registers the `@angular/cli` MCP server in `.vscode/mcp.json` alongsid
189
192
<!-- end: Angular -->
190
193
191
194
**Using the Ignite UI CLI:**
192
-
### **Option A - Use the Ignite UI CLI**
193
195
194
-
The `ai-config` command copies skill files from your installed {ProductName} package into `.claude/skills/` and writes the Ignite UI MCP server configuration to `.vscode/mcp.json`. If the files already exist and are up-to-date, the command is a no-op.
196
+
```bash
197
+
npx igniteui-cli ai-config
198
+
```
195
199
196
-
<!-- Angular -->
197
-
198
-
**Using Angular Schematics:**
200
+
If you have the Ignite UI CLI installed globally, use the shorter form:
199
201
200
202
```bash
201
-
ng generate @igniteui/angular-schematics:ai-config
203
+
ig ai-config
204
+
```
205
+
206
+
### **Option B - Manual Copy from `node_modules`**
202
207
203
208
If {ProductName} is already installed in your project, the skill files are available under `node_modules`. To copy them into your project (e.g. into `.agents/skills/`), run:
204
209
@@ -361,7 +366,7 @@ Once installed, the skill files are available in the respective location and wil
361
366
362
367
The `skills` CLI is an interactive tool that downloads and installs skills directly into your project. Run the following command in your project root:
363
368
364
-
```shell
369
+
```bash
365
370
npx skills add IgniteUI/{PackageCommon}
366
371
```
367
372
@@ -408,7 +413,6 @@ For more information on the Theming MCP, refer to the [Ignite UI Theming MCP](./
408
413
-[Ignite UI CLI](../general-cli-overview.md)
409
414
<!-- end: React, WebComponents -->
410
415
<!-- Angular -->
411
-
<!-- TODO: Not in xplat, can't link to md directly + docfx is aggressively and annoyingly treating all forms of relative links as such.. -->
412
416
- <ahref="https://www.infragistics.com/products/ignite-ui-angular/angular/components/general/getting-started">Getting Started with {ProductName}</a>
0 commit comments