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
Quickly create projects including [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-angular) and [Ignite UI for jQuery](https://www.infragistics.com/products/ignite-ui) components for a variety of frameworks.
10
+
Quickly create projects including [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-angular), [Ignite UI for React](https://www.infragistics.com/products/ignite-ui-react), [Ignite UI for Web Components](https://www.infragistics.com/products/ignite-ui-web-components) and [Ignite UI for jQuery](https://www.infragistics.com/products/ignite-ui) components.
11
11
12
12
## Overview
13
13
### Features:
@@ -19,9 +19,10 @@ Quickly create projects including [Ignite UI for Angular](https://www.infragisti
19
19
- Step by step guide
20
20
21
21
### Supported frameworks
22
-
* jQuery
23
22
* Angular
24
23
* React
24
+
* Web Components
25
+
* jQuery
25
26
26
27
### Prerequisites
27
28
The repository houses multiple packages and orchestrates building and publishing them with [lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://yarnpkg.com/lang/en/docs/workspaces/).
This will create the project and will install the needed dependencies.
97
98
98
-
Parameters besides name are optional. Framework default to "jquery", project type defaults to the first available in the framework and theme to the first available for the project. For more information visit [ig new](https://github.com/IgniteUI/igniteui-cli/wiki/New) Wiki page.
99
+
Parameters besides name are optional. Framework defaults to "jquery", project type defaults to the first available in the framework and theme to the first available for the project. For more information visit [ig new](https://github.com/IgniteUI/igniteui-cli/wiki/New) Wiki page.
99
100
100
101
#### Generate Ignite UI for Angular project
101
102
@@ -180,7 +181,7 @@ The MCP server exposes the following tools to AI assistants:
180
181
|`search_docs`| Full-text search across Ignite UI documentation |
181
182
|`get_api_reference`| Retrieve the full API reference for a component or class |
182
183
|`search_api`| Search API entries by keyword or partial component name |
183
-
|`generate_ignite_app`| Return a setup guide for a new Ignite UI project |
184
+
|`get_project_setup_guide`| Return a setup guide for a new Ignite UI project |
You can also add `Ignite UI for Angular` components to your projects by using the `igniteui/angular-schematics` package. It included schematic definitions for most of the logic present in the [`igniteui-cli`](/packages/cli). These can be called in any existing Angular project or even when creating one. You can learn more about the schematics package on from its [readme](/package/ng-schematics).
194
+
You can also add `Ignite UI for Angular` components to your projects by using the `@igniteui/angular-schematics` package. It includes schematic definitions for most of the logic present in the [`igniteui-cli`](/packages/cli), as well as an Architect Builder for starting the MCP server via `ng run <project>:mcp`. These can be called in any existing Angular project or even when creating one. You can learn more about the schematics package from its [readme](/packages/ng-schematics).
194
195
195
196
## Contribution
196
197
@@ -199,20 +200,12 @@ See the [Contribution guide](https://github.com/IgniteUI/igniteui-cli/blob/maste
199
200
### Run locally
200
201
1. Clone the repository
201
202
2. Install dependencies with `yarn install`
202
-
3. Build the MCP server and bundle it into the CLI:
203
-
```bash
204
-
cd packages/igniteui-mcp/igniteui-doc-mcp
205
-
npm install
206
-
npm run build
207
-
cd ../../..
208
-
npm run build:mcp-bundle
209
-
```
210
-
4. Build the monorepo packages: `npm run build`
211
-
5. Open in Visual Studio Code
203
+
3. Build the monorepo packages (includes MCP server): `npm run build`
204
+
4. Open in Visual Studio Code
212
205
213
-
There is a predefined launch.config file forVS Codein the root folder, so you can use VS Code View/Debug window and choose one of the predefined actions. These include launching the step by step guide, create new project for a particular framework or add components.
206
+
There is a predefined `.vscode/launch.json` file for VS Code, so you can use VS Code View/Debug window and choose one of the predefined actions. These include launching the step by step guide, create new project for a particular framework or add components.
214
207
215
-
6. Hit Start Debugging/F5
208
+
5. Hit Start Debugging/F5
216
209
217
210
#### MCP Server development
218
211
@@ -238,55 +231,38 @@ npm run build:docs:all # Build both
238
231
239
232
> **Note:** Web Components requires a one-time library build (`npm run build:publish` in the submodule) before TypeDoc can run. The build script handles this automatically.
240
233
241
-
**Bundle MCP into CLI** (from the repo root):
242
-
```bash
243
-
npm run build:mcp-bundle # Copies dist/ and docs/ into packages/cli/mcp/
244
-
```
245
-
246
-
This copies the compiled MCP server, SQLite documentation database, and API reference docs into the CLI package. The `packages/cli/mcp/` directory is a build artifact (gitignored) and must be regenerated before publishing.
247
-
248
234
**Test the MCP server locally:**
249
235
```bash
250
-
npm run build:mcp-bundle
251
236
npm run build
252
237
node packages/cli/lib/cli.js mcp # Start via CLI
253
-
# or directly:
254
-
node packages/cli/mcp/dist/index.js # Start the bundled server
255
238
```
256
239
257
-
#### Building CLI package with bundled MCP server
240
+
#### Building CLI package with MCP server
258
241
259
-
The CLI package includes the MCP server as a bundled build artifact (not an npm dependency). To produce a complete CLI package with full MCP functionality, follow these steps:
242
+
The CLI package depends on `@igniteui/mcp-server` as an npm dependency. To produce a complete CLI package with full MCP functionality, follow these steps:
260
243
261
244
```bash
262
245
# 1. Install monorepo dependencies
263
246
yarn install
264
247
265
-
# 2. Build the MCP server
248
+
# 2. Build API reference docs (optional but recommended for full functionality)
266
249
cd packages/igniteui-mcp/igniteui-doc-mcp
267
-
npm install
268
-
npm run build # Compile TypeScript + copy SQLite DB
269
-
270
-
# 3. Build API reference docs (optional but recommended for full functionality)
271
250
npm run build:docs:all # Init submodules + generate Angular + WC API docs via TypeDoc
272
251
273
-
# 4. Bundle MCP into CLI (from repo root)
252
+
#3. Build all packages for publishing (from repo root)
274
253
cd ../../..
275
-
npm run build:mcp-bundle # Copy dist/ + docs/ → packages/cli/mcp/
276
-
277
-
# 5. Build all packages for publishing
278
254
npm run build-pack
279
255
```
280
256
281
-
After step 5, `npm pack` from the repo root or `packages/cli/` will produce a tarball with the MCP server, documentation database, and API reference docs all included.
257
+
After step 3, `npm pack` from the repo root or `packages/cli/` will produce a tarball with the MCP server, documentation database, and API reference docs all included.
282
258
283
-
>**Skipping API docs:** If you skip step 3, the MCP server will still work for`list_components`, `get_doc`, `search_docs`, and `generate_ignite_app` tools using the bundled SQLite database. Only the `get_api_reference` and `search_api` tools require API docs.
259
+
> **Skipping API docs:** If you skip step 2, the MCP server will still work for `list_components`, `get_doc`, `search_docs`, and `get_project_setup_guide` tools using the bundled SQLite database. Only the `get_api_reference` and `search_api` tools require API docs.
284
260
285
261
## Data Collection
286
262
287
263
The Ignite UI CLI tool uses Google Analytics to anonymously report feature usage statistics and basic crash reports. This data is used to help improve the Ignite UI CLI tools over time. You can opt out of analytics before any data is sent by using
Copy file name to clipboardExpand all lines: packages/ng-schematics/README.md
+18-1Lines changed: 18 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,4 +43,21 @@ ng g @igniteui/angular-schematics:component [templateId] [componentName]
43
43
```
44
44
45
45
You can find all of the template definitions in the [official documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/general/cli/component-templates.html)
46
-
46
+
47
+
## MCP Server
48
+
49
+
The package includes an Architect Builder that starts the [Ignite UI MCP server](../igniteui-mcp/igniteui-doc-mcp) for AI assistant integration. The `mcp` target is automatically registered in `angular.json` when you create a new project or run `ng add`.
50
+
51
+
```bash
52
+
ng run <project>:mcp
53
+
```
54
+
55
+
Options:
56
+
57
+
-`--remote <url>` — Use a remote backend instead of the local SQLite database
58
+
-`--debug` — Enable debug logging to `mcp-server.log`
59
+
60
+
```bash
61
+
ng run my-app:mcp --remote https://your-backend-url.com
0 commit comments