Skip to content

README.md

Latest commit

 

History

History
167 lines (118 loc) · 5.04 KB

README.md

File metadata and controls

167 lines (118 loc) · 5.04 KB
Raw

@igniteui/mcp-server

MCP server for Ignite UI — provides AI assistants with component documentation search and retrieval for Angular, React, Blazor, and Web Components.

Ships with a bundled SQLite database containing pre-compressed, LLM-optimized documentation for all Ignite UI components.

Installation

npm install -g @igniteui/mcp-server

Or use directly with npx:

npx @igniteui/mcp-server

Running From Source

In order to run the MCP from this repository, git submodules must be initialized first. The repo already includes the submodule entries, but a fresh clone still needs to fetch them locally.

The common/api-docs submodule is required for local API markdown generation for all four platforms (Angular, React, Web Components, and Blazor).

Recommended first-time setup:

cd packages/igniteui-mcp/igniteui-doc-mcp
git submodule update --init common/api-docs
npm install
npm run build:docs:all
npm run build

npm run build:docs:all generates the local API markdown artifacts used by the MCP API tools for all four platforms (Angular, React, Web Components, and Blazor). Run it before starting the server.

If you need to refresh submodules to newer upstream commits later, use:

git submodule update --remote --merge

MCP Client Configuration

VS Code

Add to .vscode/mcp.json:

{
  "servers": {
    "igniteui-cli": {
      "command": "npx",
      "args": ["-y", "igniteui-cli", "mcp"]
    }
  }
}

Claude Desktop

If Ignite UI CLI is globally installed you can configure the MCP like this:

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "igniteui-cli": {
      "command": "npx",
      "args": ["-y", "igniteui-cli", "mcp"]
    }
  }
}

Cursor

If Ignite UI CLI is globally installed you can configure the MCP like this:

Add to Cursor MCP settings:

{
  "mcpServers": {
    "igniteui-cli": {
      "command": "npx",
      "args": ["-y", "igniteui-cli", "mcp"]
    }
  }
}

Available Tools

All tools require a framework parameter: angular, react, blazor, or webcomponents.

Tool Description
list_components List available Ignite UI component docs. Filter by framework and optional keyword match against filename, component name, keywords, or summary.
get_doc Return the full markdown content of a specific component doc by name (e.g., grid-editing, accordion).
search_docs Full-text search across Ignite UI docs for a specific framework. Returns top 20 results with excerpt snippets. Supports prefix matching (e.g., grid*).
search_api Search Ignite UI API entries by keyword, feature name, or partial component name.
get_api_reference Return the full API reference for a specific Ignite UI component or class by exact name.
get_project_setup_guide Returns setup guides for creating a new Ignite UI project. For Angular/React/Web Components: CLI scaffolding instructions. For Blazor: dotnet new + NuGet setup guide.

Available Prompts

Prompt Description
igniteui-usage-guide Instructions for using Ignite UI tools — framework detection, documentation lookup, and project setup.

Framework Detection

The server detects the Ignite UI framework from component prefixes in your code:

Framework Prefix Example Package
Angular Igx IgxGrid, IgxCombo igniteui-angular
React Igr IgrGrid, IgrCombo igniteui-react
Blazor Igb IgbGrid, IgbCombo IgniteUI.Blazor
Web Components Igc + Component IgcGridComponent igniteui-webcomponents

File extensions also help: .razor → Blazor, .tsx → React, .ts + .html → Angular or Web Components.

CLI Options

# Local mode (default) — uses bundled SQLite database
igniteui-mcp

# Remote mode — proxies to a backend API
igniteui-mcp --remote https://your-backend-url.com

# Enable debug logging
igniteui-mcp --debug

Environment Variables

Variable Description
DB_PATH Custom path to the SQLite database file
IGNITEUI_MCP_DOCS_BACKEND_URL Backend URL (used with --remote flag when no URL argument is provided)

Modes

Local (default)

Fully self-contained — no network access required. Uses a bundled SQLite database with FTS4 full-text search powered by sql.js (WebAssembly).

When running from a source checkout, make sure you have already run npm run build:docs:all before starting the MCP so the local API markdowns are present.

Remote

Proxies documentation requests to a backend API. Requires the --remote flag with a URL argument:

igniteui-mcp --remote https://your-backend-url.com

Or provide the URL via environment variable:

IGNITEUI_MCP_DOCS_BACKEND_URL=https://your-backend-url.com igniteui-mcp --remote

License

MIT © Infragistics