docs(*): update-ai-assited-dev-npm-redme#160
Open
radomirchev wants to merge 1 commit intomasterfrom
Open
Conversation
damyanpetev
requested changes
May 11, 2026
| This package ships with **LLM Agent Skills** — structured knowledge files that teach AI coding assistants (GitHub Copilot, Cursor, Windsurf, Claude, JetBrains AI, etc.) how to work with Ignite UI for React. The skill files are included in the [`igniteui-react`](https://www.npmjs.com/package/igniteui-react) package and also live in the [`skills/`](https://github.com/IgniteUI/igniteui-react/tree/master/skills) directory: | ||
|
|
||
|
|
||
| Ignite UI for React provides a complete AI toolchain — **Agent Skills**, the **Ignite UI CLI MCP server**, the **Ignite UI Theming MCP server**, and the **MAKER MCP server** — that grounds AI coding assistants in correct component APIs, import paths, and design tokens. |
Member
There was a problem hiding this comment.
Wouldn't go as far as say it's a complete or even a toolchain really.
You can say the Agent skills and MCP-s "enhance the AI coding [workflow]" for example.
Comment on lines
+68
to
+70
| | Component | What it provides | Requires Ignite UI installed? | | ||
| |:----------|:----------------|:-----------------------------:| | ||
| | **Agent Skills** | Developer-owned instruction packages: import paths, component patterns, decision flows, project conventions | Yes | |
Member
There was a problem hiding this comment.
Skills can be be delivered via ig ai-config without the package, that was the point and we're enhancing that to work even without existing project structure so the last value is also "no" here and TBH just drop the last column entirely - doesn't add useful info.
Member
There was a problem hiding this comment.
Also is project conversion supposed to be the image to design skill? Because it's a bit vague what that should be
| | **Theming MCP server** (`igniteui-theming`) | Design tokens, palette tools, CSS custom property generation, WCAG AA contrast validation | No | | ||
| | **MAKER MCP server** (`@igniteui/maker-mcp`) | Multi-agent orchestration: decomposes complex tasks into validated, executable step plans | No | | ||
|
|
||
| > **Note:** All AI toolchain commands require Ignite UI CLI 16.0.0 or newer. |
Comment on lines
+77
to
+78
| You can start evaluating Ignite UI AI assistance with the MCP servers alone — Ignite UI does not need to be installed in your project. Agent Skills become available once you install Ignite UI packages. | ||
|
|
Member
There was a problem hiding this comment.
Suggested change
| You can start evaluating Ignite UI AI assistance with the MCP servers alone — Ignite UI does not need to be installed in your project. Agent Skills become available once you install Ignite UI packages. | |
| Run this command from the root of your project: | ||
|
|
||
| ```bash | ||
| npx igniteui-cli ai-config |
Member
There was a problem hiding this comment.
If you're giving instructions to install the package at the end and the other examples uses ig, use that consistently:
Suggested change
| npx igniteui-cli ai-config | |
| ig ai-config |
| ig new | ||
| ``` | ||
|
|
||
| The CLI prompts for project name and theme, installs dependencies, and configures Agent Skills and MCP servers in a single interactive flow. If the CLI is not installed globally, use `npm install -g igniteui-cli`. |
Member
There was a problem hiding this comment.
Again don't see how explaining the name prompts and the install of deps is useful information. Just explain you can scaffold a new project with pre-configured AI setup, run ig new and follow the prompts.
The install of the package could be pulled ether before the two sections or added as a note under both snippets
|
|
||
| ### Agent Skills | ||
|
|
||
| This package ships with **Agent Skills** — structured, developer-owned instruction packages that tell AI coding assistants exactly how to use Ignite UI for React. The skill files are included in the [`igniteui-react`](https://www.npmjs.com/package/igniteui-react) package and also live in the [`skills/`](https://github.com/IgniteUI/igniteui-react/tree/master/skills) directory. |
Member
There was a problem hiding this comment.
I liked the original description paragraph we use across repos better, the "developer-owned instruction packages" says a lot of words, but can't tell what it means TBH.
| | **customize-theme** | Customize styling using CSS custom properties, Sass, and the theming system in React | | ||
| | **optimize-bundle-size** | Reduce bundle size with granular imports, tree-shaking, and lazy loading | | ||
|
|
||
| When a Skill is active in the AI client, the agent follows the Skill instead of relying on general training data — which may reference outdated API signatures or import paths. The Skill package is developer-owned: edit the `SKILL.md` to match your team's conventions, add project-specific patterns, and version the package alongside your codebase. |
Member
There was a problem hiding this comment.
Not sure we need to explicitly explain what that is, could easily just link one of the agent skills mentions to https://agentskills.io/home
Oh, and while true, not sure we want to encourage that since it interferes with update options and "version the package" is wrong since it's not a package, so delete the last part at least, if not the whole section
Suggested change
| When a Skill is active in the AI client, the agent follows the Skill instead of relying on general training data — which may reference outdated API signatures or import paths. The Skill package is developer-owned: edit the `SKILL.md` to match your team's conventions, add project-specific patterns, and version the package alongside your codebase. | |
| When a Skill is active in the AI client, the agent follows the Skill instead of relying on general training data — which may reference outdated API signatures or import paths. |
Comment on lines
+111
to
+122
| ### Supported AI Clients | ||
|
|
||
| | Client | Configuration method | | ||
| |:-------|:--------------------| | ||
| | VS Code with GitHub Copilot | `.vscode/mcp.json` | | ||
| | Cursor | `.cursor/mcp.json` | | ||
| | Claude Desktop (macOS) | `~/Library/Application Support/Claude/claude_desktop_config.json` | | ||
| | Claude Desktop (Windows) | `%APPDATA%\Claude\claude_desktop_config.json` | | ||
| | Claude Code | `.mcp.json` or the Claude Code MCP CLI command | | ||
| | JetBrains AI Assistant | **Tools → AI Assistant → Model Context Protocol (MCP)** | | ||
|
|
||
| Agent Skills are compatible with GitHub Copilot via `.github/copilot-instructions.md`, Cursor via `.cursorrules` or `.cursor/rules/`, Windsurf via `.windsurfrules`, and JetBrains AI Assistant via project-level prompt settings. |
Member
There was a problem hiding this comment.
Please no.
- We haven't release the update to pick different MCP configs yet, not sure where that list came from, besides being inaccurate.
- Skills are not instructions (which we set up as well) or rules
- There are so many agents/tools and a lot of them support skills and almost all of them work with
.agents/skills(except claude, which we cover as well), so you can't put a definitive list.
Suggested change
| ### Supported AI Clients | |
| | Client | Configuration method | | |
| |:-------|:--------------------| | |
| | VS Code with GitHub Copilot | `.vscode/mcp.json` | | |
| | Cursor | `.cursor/mcp.json` | | |
| | Claude Desktop (macOS) | `~/Library/Application Support/Claude/claude_desktop_config.json` | | |
| | Claude Desktop (Windows) | `%APPDATA%\Claude\claude_desktop_config.json` | | |
| | Claude Code | `.mcp.json` or the Claude Code MCP CLI command | | |
| | JetBrains AI Assistant | **Tools → AI Assistant → Model Context Protocol (MCP)** | | |
| Agent Skills are compatible with GitHub Copilot via `.github/copilot-instructions.md`, Cursor via `.cursorrules` or `.cursor/rules/`, Windsurf via `.windsurfrules`, and JetBrains AI Assistant via project-level prompt settings. |
|
|
||
| ### Agent Skills | ||
|
|
||
| This package ships with **Agent Skills** — structured, developer-owned instruction packages that tell AI coding assistants exactly how to use Ignite UI for React. The skill files are included in the [`igniteui-react`](https://www.npmjs.com/package/igniteui-react) package and also live in the [`skills/`](https://github.com/IgniteUI/igniteui-react/tree/master/skills) directory. |
Member
There was a problem hiding this comment.
Not this package as the description clearly states
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #
Additional information (check all that apply):
Checklist:
README.MDCHANGELOG.MDupdates for newly added functionality