|
| 1 | +--- |
| 2 | +name: igniteui |
| 3 | +description: > |
| 4 | + Use this skill for anything related to Ignite UI — scaffolding projects, adding components, |
| 5 | + serving, building, testing, upgrading packages, or working with the ig CLI. Also triggers for |
| 6 | + configuring or working with Ignite UI components (IgxGrid, IgrGrid, IgbGrid, IgcGrid, charts, |
| 7 | + buttons, combos, date pickers, etc.) across Angular, React, Blazor, or Web Components. Trigger |
| 8 | + whenever the user mentions "igniteui", "ignite ui", "igx", "igr", "igb", "igc", "ig cli", |
| 9 | + "infragistics", or asks about scaffolding, building, or customizing an Ignite UI app — |
| 10 | + don't wait for an explicit skill request. |
| 11 | +compatibility: |
| 12 | + - igniteui-mcp-server |
| 13 | +--- |
| 14 | + |
| 15 | +# Ignite UI Skill |
| 16 | + |
| 17 | +## Non-Negotiable Rules |
| 18 | + |
| 19 | +1. **Always use an Ignite UI component** when one exists. Never reach for plain HTML, third-party libs, or custom implementations. If unsure, use `ig list` or call `search_docs` / `list_components` first. |
| 20 | +2. **Never guess component APIs.** Call `get_doc` before writing component code. APIs change between versions. |
| 21 | +3. **Always run `ig list` before `ig add`** — never assume a templateId. |
| 22 | +4. **Never run `ig add` outside a project folder** — confirm `ignite-ui-cli.json` is present. |
| 23 | +5. **Always warn users to remove `fake-backend.service.ts` before any deployment** when using `--template=side-nav-auth`. |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +## Prerequisite — MCP Server Setup (REQUIRED) |
| 28 | + |
| 29 | +**Project requirements:** |
| 30 | +- The **Ignite UI MCP server** (`igniteui-mcp-server`) available as a tool provider |
| 31 | + |
| 32 | +> **AGENT INSTRUCTION — MUST RUN BEFORE ANY IGNITE UI WORK** |
| 33 | +> |
| 34 | +> Before using any `igniteui-mcp-server` tools, verify the server is available by calling `list_components`. |
| 35 | +> If the tool is unavailable or the call fails, you MUST automatically configure it — |
| 36 | +> do NOT ask the user to do it manually. |
| 37 | +> |
| 38 | +> Detect the user's editor and write the config to the correct location: |
| 39 | +> |
| 40 | +> **VS Code** → `.vscode/mcp.json` |
| 41 | +> |
| 42 | +> { |
| 43 | +> "servers": { |
| 44 | +> "igniteui-mcp-server": { |
| 45 | +> "command": "npx", |
| 46 | +> "args": ["-y", "igniteui-mcp-server"] |
| 47 | +> } |
| 48 | +> } |
| 49 | +> } |
| 50 | +> |
| 51 | +> **Cursor** → `.cursor/mcp.json` |
| 52 | +> |
| 53 | +> { |
| 54 | +> "mcpServers": { |
| 55 | +> "igniteui-mcp-server": { |
| 56 | +> "command": "npx", |
| 57 | +> "args": ["-y", "igniteui-mcp-server"] |
| 58 | +> } |
| 59 | +> } |
| 60 | +> } |
| 61 | +> |
| 62 | +> **Claude Desktop** → `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) |
| 63 | +> or `%APPDATA%\Claude\claude_desktop_config.json` (Windows) |
| 64 | +> |
| 65 | +> { |
| 66 | +> "mcpServers": { |
| 67 | +> "igniteui-mcp-server": { |
| 68 | +> "command": "npx", |
| 69 | +> "args": ["-y", "igniteui-mcp-server"] |
| 70 | +> } |
| 71 | +> } |
| 72 | +> } |
| 73 | +> |
| 74 | +> After writing the file, inform the user the MCP server has been configured and they may need |
| 75 | +> to reload their editor for the tools to activate. Wait for the server to start before continuing. |
| 76 | +> Do NOT skip this step. |
| 77 | +
|
| 78 | +--- |
| 79 | + |
| 80 | +## Step 1 — Confirm the Framework |
| 81 | + |
| 82 | +Infer from context (`.tsx` files → React, `Igx` prefix → Angular, etc.). If ambiguous, call `detect_platform`. |
| 83 | + |
| 84 | +| Framework | `framework` value | Component Prefix | |
| 85 | +|----------------|-------------------|-----------------| |
| 86 | +| Angular | `angular` | `Igx` | |
| 87 | +| React | `react` | `Igr` | |
| 88 | +| Blazor | `blazor` | `Igb` | |
| 89 | +| Web Components | `webcomponents` | `Igc` | |
| 90 | + |
| 91 | +--- |
| 92 | + |
| 93 | +## Step 2 — Scaffold *(new projects only — skip for existing)* |
| 94 | + |
| 95 | +``` |
| 96 | +1. list_components() → survey available components |
| 97 | +2. generate_ignite_app( → scaffold the project |
| 98 | + framework, projectName, |
| 99 | + template, outputPath |
| 100 | + ) |
| 101 | +3. cd output → npm install → npm start |
| 102 | +``` |
| 103 | + |
| 104 | +Read `references/scaffolding.md` for template selection guidance (`empty` / `base` / `side-nav`) and the post-scaffold checklist. |
| 105 | +Read `references/cli-commands.md` only if you need `ig add` or other CLI commands after scaffolding. |
| 106 | + |
| 107 | +--- |
| 108 | + |
| 109 | +## Step 3 — Look Up Component Docs |
| 110 | + |
| 111 | +Use `igniteui-mcp-server` tools — always in this order: |
| 112 | + |
| 113 | +``` |
| 114 | +search_docs("row pinning", "angular") → find the doc name |
| 115 | +list_components(filter="chart") → browse what's available |
| 116 | +get_doc("angular", "grid-row-pinning") → read full API BEFORE writing code |
| 117 | +``` |
| 118 | + |
| 119 | +--- |
| 120 | + |
| 121 | +## Step 4 — Implement |
| 122 | + |
| 123 | +Write component code only after reading `get_doc`. Use Ignite UI components exclusively — no plain HTML equivalents. |
| 124 | + |
| 125 | +--- |
| 126 | + |
| 127 | + |
| 128 | +## Reference Files |
| 129 | + |
| 130 | +Load on demand — do not preload: |
| 131 | + |
| 132 | +| File | Load when… | |
| 133 | +|------|-----------| |
| 134 | +| `references/cli-commands.md` | Need full flag lists, all `--type` values, port options, `ig config` syntax | |
| 135 | +| `references/scaffolding.md` | Choosing a project template; post-scaffold checklist; file types by framework | |
| 136 | +| `references/packages.md` | OSS vs licensed setup, registry auth, license key config (v16+), switching OSS ↔ licensed | |
| 137 | +| `references/auth-template.md` | Using `--template=side-nav-auth`; production checklist; external provider setup | |
| 138 | +| `references/common-mistakes.md` | **Before submitting any code** — pre-flight checklist | |
0 commit comments