Skip to content

Commit 4b2494a

Browse files
Copilotkdinev
andcommitted
Update documentation for MCP server and add example config
Co-authored-by: kdinev <1472513+kdinev@users.noreply.github.com>
1 parent bf44ce3 commit 4b2494a

3 files changed

Lines changed: 52 additions & 2 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ This monorepo contains several packages that combine into the `igniteui-cli`:
3838
| [@igniteui/angular-templates](https://www.npmjs.com/package/@igniteui/angular-templates) | Contains the template definitions for Angular components | [packages/igx-templates](./packages/igx-templates) |
3939
| [@igniteui/angular-schematics](https://www.npmjs.com/package/@igniteui/angular-schematics) | IgniteUI CLI implementation to be used with Angular CLI's schematics engine | [packages/ng-schematics](./packages/ng-schematics) |
4040
| [igniteui-cli](https://www.npmjs.com/package/igniteui-cli) | Standalone IgniteUI CLI tool for React, jQuery and Angular | [packages/cli](./packages/cli) |
41+
| [@igniteui/mcp-server](https://www.npmjs.com/package/@igniteui/mcp-server) | Model Context Protocol (MCP) server for AI-assisted project creation | [packages/mcp-server](./packages/mcp-server) |
4142

4243
## Table of Contents
4344

@@ -137,6 +138,40 @@ ig build
137138
ig start
138139
```
139140

141+
## MCP Server
142+
143+
The Ignite UI CLI now includes a Model Context Protocol (MCP) server that enables AI assistants like Claude to create and manage Ignite UI projects programmatically. The MCP server exposes three main tools:
144+
145+
1. **create_igniteui_project** - Create new projects for Angular, React, Web Components, or jQuery
146+
2. **upgrade_to_licensed** - Upgrade projects from trial to licensed versions
147+
3. **generate_from_docs** - Access documentation and generate component code
148+
149+
### Installation
150+
151+
```bash
152+
npm install -g @igniteui/mcp-server
153+
```
154+
155+
### Usage with Claude Desktop
156+
157+
Add to your Claude Desktop configuration:
158+
159+
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
160+
**Windows**: `%APPDATA%/Claude/claude_desktop_config.json`
161+
162+
```json
163+
{
164+
"mcpServers": {
165+
"igniteui": {
166+
"command": "npx",
167+
"args": ["-y", "@igniteui/mcp-server"]
168+
}
169+
}
170+
}
171+
```
172+
173+
For more details, see the [MCP Server documentation](./packages/mcp-server/README.md).
174+
140175
## Schematics
141176
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).
142177

packages/mcp-server/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,12 @@ Create a new Ignite UI project for the specified framework.
5959
**Parameters:**
6060
- `name` (required): Project name
6161
- `framework` (required): One of `angular`, `react`, `webcomponents`, or `jquery`
62-
- `projectType` (optional): Project type (e.g., `igx-ts` for Angular, `igr-es6` or `igr-ts` for React, `igc-ts` for Web Components)
62+
- `projectType` (optional): Project type specific to the framework:
63+
- Angular: `igx-ts` (TypeScript with Ignite UI)
64+
- React: `es6`, `igr-es6`, or `igr-ts` (TypeScript with Ignite UI)
65+
- Web Components: `igc-ts` (TypeScript with Ignite UI)
66+
- jQuery: `js` (JavaScript)
67+
- If not specified, uses the first available type for the framework
6368
- `template` (optional): Project template (e.g., `empty`, `side-nav`, `side-nav-auth`)
6469
- `theme` (optional): Theme name
6570
- `skipGit` (optional): Skip Git initialization (default: false)
@@ -77,7 +82,9 @@ Create a new Ignite UI project for the specified framework.
7782

7883
### 2. upgrade_to_licensed
7984

80-
Upgrade an Ignite UI project from trial to licensed version.
85+
Upgrade an Ignite UI project from trial to licensed version. This command updates the package.json file to use the licensed Ignite UI packages instead of trial versions. This is useful when you have obtained a license for Ignite UI and want to upgrade an existing project.
86+
87+
**Note**: This command works with Angular (igx-ts), React (igr-ts), and Web Components (igc-ts) projects. jQuery projects do not support this upgrade path.
8188

8289
**Parameters:**
8390
- `projectPath` (optional): Path to project directory (defaults to current directory)
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"mcpServers": {
3+
"igniteui": {
4+
"command": "npx",
5+
"args": ["-y", "@igniteui/mcp-server"]
6+
}
7+
}
8+
}

0 commit comments

Comments
 (0)