|
| 1 | +# MCP Server Implementation |
| 2 | + |
| 3 | +This document describes the Model Context Protocol (MCP) server implementation for the Ignite UI CLI and Angular Schematics packages. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +The MCP server provides a programmatic interface for AI assistants to interact with Ignite UI CLI functionality. It follows the [Model Context Protocol](https://modelcontextprotocol.io/) specification. |
| 8 | + |
| 9 | +## Packages |
| 10 | + |
| 11 | +### @igniteui/cli MCP Server |
| 12 | + |
| 13 | +The CLI package includes an `mcp` command that exposes key CLI functionality through MCP tools. |
| 14 | + |
| 15 | +#### Usage |
| 16 | + |
| 17 | +To start the MCP server: |
| 18 | + |
| 19 | +```bash |
| 20 | +ig mcp |
| 21 | +``` |
| 22 | + |
| 23 | +Or via npx: |
| 24 | + |
| 25 | +```bash |
| 26 | +npx igniteui-cli mcp |
| 27 | +``` |
| 28 | + |
| 29 | +#### Configuration |
| 30 | + |
| 31 | +Add the following configuration to your MCP host: |
| 32 | + |
| 33 | +```json |
| 34 | +{ |
| 35 | + "mcpServers": { |
| 36 | + "igniteui-cli": { |
| 37 | + "command": "npx", |
| 38 | + "args": ["-y", "igniteui-cli", "mcp"] |
| 39 | + } |
| 40 | + } |
| 41 | +} |
| 42 | +``` |
| 43 | + |
| 44 | +#### Available Tools |
| 45 | + |
| 46 | +1. **ig_new** - Create a new Ignite UI project |
| 47 | + - Parameters: name, framework, type, theme, skipGit, skipInstall, template |
| 48 | + |
| 49 | +2. **ig_add** - Add a component template to an existing project |
| 50 | + - Parameters: template, name, module, skipRoute |
| 51 | + |
| 52 | +3. **ig_upgrade_packages** - Upgrade Ignite UI packages |
| 53 | + - Parameters: skipInstall |
| 54 | + |
| 55 | +4. **ig_list_templates** - List available frameworks and templates |
| 56 | + - No parameters |
| 57 | + |
| 58 | +5. **ig_interactive** - Start interactive step-by-step mode |
| 59 | + - No parameters |
| 60 | + |
| 61 | +#### Options |
| 62 | + |
| 63 | +- `--read-only`: Only register read-only tools (default: false) |
| 64 | + |
| 65 | +### @igniteui/angular-schematics MCP Server |
| 66 | + |
| 67 | +The ng-schematics package includes an MCP server for Angular-specific functionality. |
| 68 | + |
| 69 | +#### Usage |
| 70 | + |
| 71 | +Via Angular CLI schematic: |
| 72 | + |
| 73 | +```bash |
| 74 | +ng generate @igniteui/angular-schematics:mcp |
| 75 | +``` |
| 76 | + |
| 77 | +#### Available Tools |
| 78 | + |
| 79 | +1. **ng_new_igniteui** - Create a new Angular project with Ignite UI |
| 80 | + - Parameters: name, template, theme, skipGit |
| 81 | + |
| 82 | +2. **ng_add_component** - Add an Ignite UI component |
| 83 | + - Parameters: template, name, module, skipRoute |
| 84 | + |
| 85 | +3. **ng_list_components** - List available components |
| 86 | + - No parameters |
| 87 | + |
| 88 | +4. **ng_upgrade_packages** - Upgrade to licensed packages |
| 89 | + - No parameters |
| 90 | + |
| 91 | +## Development |
| 92 | + |
| 93 | +### Building |
| 94 | + |
| 95 | +```bash |
| 96 | +npm run build |
| 97 | +``` |
| 98 | + |
| 99 | +### Testing |
| 100 | + |
| 101 | +```bash |
| 102 | +npm test |
| 103 | +``` |
| 104 | + |
| 105 | +### Linting |
| 106 | + |
| 107 | +```bash |
| 108 | +npm run lint |
| 109 | +``` |
| 110 | + |
| 111 | +## Implementation Details |
| 112 | + |
| 113 | +- Both packages use the `@modelcontextprotocol/sdk` library |
| 114 | +- The MCP server uses stdio transport for communication |
| 115 | +- When run in a TTY (interactive terminal), the command displays usage instructions |
| 116 | +- When run non-interactively (e.g., from an MCP host), it starts the MCP server |
| 117 | + |
| 118 | +## References |
| 119 | + |
| 120 | +- [Model Context Protocol](https://modelcontextprotocol.io/) |
| 121 | +- [Ignite UI CLI Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/general/cli/getting-started-with-angular-schematics) |
| 122 | +- [Angular CLI MCP Implementation](https://github.com/angular/angular-cli/tree/main/packages/angular/cli/src/commands/mcp) |
0 commit comments