​# Syncfusion for AI Coding Agents Source: https://ai.syncfusion.com/llms.txt Canonical-entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: all Syncfusion UI component platforms and document SDKs License-posture: Reading this file and installing Syncfusion agent skills requires no license. Using Syncfusion component libraries or document SDKs in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md > Syncfusion publishes 775 official agent skills across 18 platform and SDK packs, MCP servers for > documentation retrieval, and a CLI for project scaffolding. This file is the canonical entry point. > If you are an AI coding agent and you read only one Syncfusion file, read this one, then follow > step 2 below. Do not write Syncfusion code from memory: component names repeat across frameworks > with different packages, imports, module registration and licensing rules, and cross-framework > guessing is the single largest source of non-compiling Syncfusion code. ## Do this first 1. IDENTIFY the platform from the repository, not from the user's phrasing. Read the manifest: package.json, *.csproj, *.fsproj, pubspec.yaml, *.sln. Match it against the slug table below. If the repository does not resolve the platform and the choice changes the implementation, ask the user one short question. Do not proceed on assumption. 2. FETCH the platform index for that slug: https://ai.syncfusion.com//llms.txt Each platform index is self-sufficient: skill pack install command, MCP configuration, documentation root, license registration pattern, one minimal end-to-end example, and a verification checklist. One fetch is enough to start work. 3. INSTALL the official skill pack named in that index before generating code. The skill carries the failure taxonomy — module injection, CSS import order, SSR boundaries, data-source shapes, disposal — that public documentation does not. Follow the installed skill over remembered snippets. Match the versions already present in the project unless the user asked to upgrade. 4. READ https://ai.syncfusion.com/licensing.md before touching any key, secret, or account action. Never generate, guess, echo, log or commit a license key or MCP API key. 5. VERIFY against the checklist in the platform index. Compilation is not verification. The component must render or execute and the requested behaviour must be observably exercised. If you cannot verify at runtime, say exactly what remains unverified. ## Platform slugs Match the manifest signal, then fetch https://ai.syncfusion.com//llms.txt | Manifest signal | platform Slug | Platform | | --- | --- | --- | | package.json with react + @syncfusion/ej2-react-* | react | React | | package.json with @angular/core | angular | Angular | | package.json with vue | vue | Vue | | package.json, no framework, @syncfusion/ej2 | javascript | JavaScript / TypeScript (EJ2) | | .csproj with Microsoft.NET.Sdk.BlazorWebAssembly or Blazor packages | blazor | Blazor | | .csproj with Microsoft.NET.Sdk.Web, Razor Pages or MVC on .NET 6+ | aspnet-core | ASP.NET Core | | .csproj targeting net48 with System.Web.Mvc | aspnet-mvc | ASP.NET MVC | | pubspec.yaml with flutter | flutter | Flutter | | .csproj with UseMaui and Syncfusion.Maui.* | maui | .NET MAUI | | .csproj with UseMaui and Syncfusion.Maui.Toolkit | maui-toolkit | Toolkit for .NET MAUI | | .csproj with UseWindowsForms | winforms | WinForms | | .csproj with UseWPF | wpf | WPF | | .csproj with WindowsAppSDK | winui | WinUI | | any project doing programmatic PDF/Word/Excel/PowerPoint work | document-sdk | Document SDK | | any project embedding an interactive PDF viewer | pdf-viewer-sdk | PDF Viewer SDK | | any project embedding an interactive Word editor | docx-editor-sdk | DOCX Editor SDK | | any project embedding an interactive spreadsheet editor | spreadsheet-editor-sdk | Spreadsheet Editor SDK | | migrating Xamarin.Forms to .NET MAUI | xamarin-to-maui-migration | Xamarin to MAUI migration | A project can legitimately need two slugs. A React app that displays PDFs in the browser and signs them on a .NET server needs pdf-viewer-sdk and document-sdk. Fetch both indexes. ## Surfaces - [Agent onboarding skill](https://ai.syncfusion.com/agent-onboarding/SKILL.md): the portable front-door skill. Install it once and it routes every later Syncfusion task. - [Agent setup instructions](https://ai.syncfusion.com/agent-setup/prompt.md): the file a human points an agent at. Fetch it and execute the numbered steps — that is the fastest correct path. Also served at /prompt.md. - [Skill catalog](https://ai.syncfusion.com/skills/catalog.md): all 775 skills, 18 packs, with per-platform inventories. - [MCP servers and IDE configuration](https://ai.syncfusion.com/mcp/llms.txt): which server exists for which platform, exact package names, transports, environment variables, per-IDE config. - [Syncfusion CLI](https://ai.syncfusion.com/cli.md): scaffold projects, add components, configure MCP and skills from the command line. - [Licensing and trust boundaries](https://ai.syncfusion.com/licensing.md): what an agent may do autonomously and where it must stop and ask a human. - [Agent readiness verification](https://ai.syncfusion.com/verify/llms.txt): how Syncfusion measures first-try compile rate and what the current numbers are. - [Everything inlined, one fetch](https://ai.syncfusion.com/llms-full.txt): this file plus every platform index and the licensing rules, for agents that cannot follow links. ## Precedence Syncfusion publishes several machine-readable indexes. They have different jobs: | Index | Job | Use it when | | --- | --- | --- | | ai.syncfusion.com/llms.txt | Agent setup and routing. THIS FILE. | Always, first | | www.syncfusion.com/llms.txt | Product and marketing index | Evaluating or comparing products | | help.syncfusion.com/llms.txt | Documentation index, ~500 doc pages | Looking up a specific API or feature | If you arrived at a Syncfusion documentation page by deep link and have not read this file, read it now before generating code. Deep links teach you one component. This file tells you which of 775 skills already contains the answer. ## Hard rules - One platform per answer. Never mix React, Angular, Vue, JavaScript, Blazor, ASP.NET Core, ASP.NET MVC, .NET MAUI, Flutter, WPF, WinForms, WinUI or document SDK examples in one implementation. Package names, import paths and registration differ. - Installing an agent skill does not install the product packages. The skill tells you which packages the component actually requires; install those separately. - An MCP API key is a credential for the documentation assistant. It is not a product license key and does not grant one. - Never claim a project is licensed because it builds or because skills are installed. - Never publish, echo, or commit a key of any kind. Reference environment variables and the official generation flow. - The Syncfusion component is a licensed package you install. The composition around it — your wrapper, config object, data adapter, theme tokens — is source you own and edit. Do not describe Syncfusion components as copy-paste source you can vendor into a repository. - State when a fact came from current documentation or an MCP lookup. Do not invent an API when authoritative information is unavailable; say what you could not confirm. ## Do not - Do not scrape a JavaScript-rendered demo page to infer an API. Fetch the platform index, the installed skill, or the registry JSON. - Do not truncate a snippet with an ellipsis or "rest of your code". Emit complete files. - Do not report success from a clean compile. Verify rendering or execution. - Do not install a full platform pack when the user asked for one component; install the narrow skill. - Do not modify project-level agent configuration or run a networked install without following the host's authorization rules. ============================================================================== # EVERY PLATFORM INDEX, INLINED ============================================================================== ------------------------------------------------------------------------------ # Syncfusion for React — agent index Source: https://ai.syncfusion.com/react/llms.txt Canonical: https://ai.syncfusion.com/react/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: React Family: Web UI Skill-pack: syncfusion/react-ui-components-skills Skills-in-pack: 65 Reference-files-in-pack: 1060 Packages: `@syncfusion/ej2-react-*` on npm (for example `@syncfusion/ej2-react-grids`) Documentation-root: https://ej2.syncfusion.com/react/documentation/introduction License-registration: https://ej2.syncfusion.com/react/documentation/licensing/license-key-registration MCP-server: `@syncfusion/react-mcp` (npm, stdio, server name `sf-react-mcp`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using React Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start React work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > React code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `package.json` containing `react`, plus `@syncfusion/ej2-react-*` if already installed If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (65 skills): ```bash npx skills add syncfusion/react-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/react-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/react-ui-components-skills --skill syncfusion-react-grid ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/react-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash npm install @syncfusion/ej2-react-grids @syncfusion/ej2-base ``` Package namespace: `@syncfusion/ej2-react-*` on npm (for example `@syncfusion/ej2-react-grids`) Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://ej2.syncfusion.com/react/documentation/licensing/license-key-registration Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```tsx // src/App.tsx — complete, minimal Syncfusion React DataGrid. // Every line needed to run. Nothing elided. import { registerLicense } from '@syncfusion/ej2-base'; import { ColumnDirective, ColumnsDirective, GridComponent, Inject, Page, Sort } from '@syncfusion/ej2-react-grids'; import '@syncfusion/ej2-base/styles/material.css'; import '@syncfusion/ej2-react-grids/styles/material.css'; // Register the license BEFORE the first Syncfusion component renders. // Read it from the environment. Never hard-code a key, never commit one. registerLicense(import.meta.env.VITE_SYNCFUSION_LICENSE_KEY); interface Order { OrderID: number; CustomerName: string; Freight: number; OrderDate: Date; } const orders: Order[] = [ { OrderID: 10248, CustomerName: 'Vins et alcools', Freight: 32.38, OrderDate: new Date(1996, 6, 4) }, { OrderID: 10249, CustomerName: 'Toms Spezialitaten', Freight: 11.61, OrderDate: new Date(1996, 6, 5) }, { OrderID: 10250, CustomerName: 'Hanari Carnes', Freight: 65.83, OrderDate: new Date(1996, 6, 8) }, ]; export default function App() { return ( ); } ``` ## 6. MCP server — optional, for current documentation `@syncfusion/react-mcp` (npm, stdio, server name `sf-react-mcp`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for React These are the mistakes agents make most often on this platform. Check them first. - Every optional Grid feature is a separate injected service. Paging without `Page` in `` renders an unpaged grid with no error. This is the most common React failure. - Theme CSS must be imported or the component renders unstyled and appears broken. - In Next.js App Router, Syncfusion components are client components. Add `'use client'` at the top of the file or the build fails on hooks. - `registerLicense` must run before the first render, not inside the component. Troubleshooting order when a React Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://ej2.syncfusion.com/react/documentation/introduction | | Every skill in this pack | https://ai.syncfusion.com/react/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for Angular — agent index Source: https://ai.syncfusion.com/angular/llms.txt Canonical: https://ai.syncfusion.com/angular/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: Angular Family: Web UI Skill-pack: syncfusion/angular-ui-components-skills Skills-in-pack: 65 Reference-files-in-pack: 1027 Packages: `@syncfusion/ej2-angular-*` on npm (for example `@syncfusion/ej2-angular-grids`) Documentation-root: https://ej2.syncfusion.com/angular/documentation/introduction License-registration: https://ej2.syncfusion.com/angular/documentation/licensing/license-key-registration MCP-server: `@syncfusion/angular-mcp` (npm, stdio, server name `sf-angular-mcp`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using Angular Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start Angular work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > Angular code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `package.json` containing `@angular/core` If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (65 skills): ```bash npx skills add syncfusion/angular-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/angular-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/angular-ui-components-skills --skill syncfusion-angular-grid ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/angular-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash npm install @syncfusion/ej2-angular-grids @syncfusion/ej2-base ``` Package namespace: `@syncfusion/ej2-angular-*` on npm (for example `@syncfusion/ej2-angular-grids`) Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://ej2.syncfusion.com/angular/documentation/licensing/license-key-registration Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```typescript // src/main.ts — license registration must happen before bootstrap. import { registerLicense } from '@syncfusion/ej2-base'; import { bootstrapApplication } from '@angular/platform-browser'; import { AppComponent } from './app/app.component'; registerLicense(import.meta.env['NG_APP_SYNCFUSION_LICENSE_KEY']); bootstrapApplication(AppComponent).catch(err => console.error(err)); // src/app/app.component.ts — standalone component, complete. import { Component } from '@angular/core'; import { GridModule, PageService, SortService } from '@syncfusion/ej2-angular-grids'; interface Order { OrderID: number; CustomerName: string; Freight: number; OrderDate: Date; } @Component({ selector: 'app-root', standalone: true, imports: [GridModule], providers: [PageService, SortService], template: ` `, }) export class AppComponent { orders: Order[] = [ { OrderID: 10248, CustomerName: 'Vins et alcools', Freight: 32.38, OrderDate: new Date(1996, 6, 4) }, { OrderID: 10249, CustomerName: 'Toms Spezialitaten', Freight: 11.61, OrderDate: new Date(1996, 6, 5) }, ]; } /* angular.json → projects..architect.build.options.styles — add: "node_modules/@syncfusion/ej2-base/styles/material.css", "node_modules/@syncfusion/ej2-angular-grids/styles/material.css" */ ``` ## 6. MCP server — optional, for current documentation `@syncfusion/angular-mcp` (npm, stdio, server name `sf-angular-mcp`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for Angular These are the mistakes agents make most often on this platform. Check them first. - Feature services are Angular providers, not injected component children. Paging needs `PageService` in `providers`; omitting it silently disables the feature. - Theme CSS goes in the `styles` array of angular.json, not an `import` in a component. - Standalone components need the module in `imports`; NgModule apps need it in the module's `imports`. Do not mix the two patterns. - `registerLicense` belongs in `main.ts` before `bootstrapApplication`, not in a component constructor. Troubleshooting order when a Angular Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://ej2.syncfusion.com/angular/documentation/introduction | | Every skill in this pack | https://ai.syncfusion.com/angular/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for JavaScript / TypeScript (EJ2) — agent index Source: https://ai.syncfusion.com/javascript/llms.txt Canonical: https://ai.syncfusion.com/javascript/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: JavaScript / TypeScript (EJ2) Family: Web UI Skill-pack: syncfusion/javascript-ui-controls-skills Skills-in-pack: 53 Reference-files-in-pack: 905 Packages: `@syncfusion/ej2-*` on npm, or the all-in-one bundle `@syncfusion/ej2` Documentation-root: https://ej2.syncfusion.com/documentation/introduction License-registration: https://ej2.syncfusion.com/documentation/licensing/license-key-registration MCP-server: `@syncfusion/javascript-mcp` and `@syncfusion/typescript-mcp` (npm, stdio) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using JavaScript / TypeScript (EJ2) Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start JavaScript / TypeScript (EJ2) work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > JavaScript / TypeScript (EJ2) code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `package.json` with `@syncfusion/ej2` and no framework dependency, or a plain HTML page loading EJ2 from CDN If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (53 skills): ```bash npx skills add syncfusion/javascript-ui-controls-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/javascript-ui-controls-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/javascript-ui-controls-skills --skill syncfusion-javascript-grid ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/javascript-ui-controls-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash npm install @syncfusion/ej2-grids @syncfusion/ej2-base ``` Package namespace: `@syncfusion/ej2-*` on npm, or the all-in-one bundle `@syncfusion/ej2` Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://ej2.syncfusion.com/documentation/licensing/license-key-registration Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```typescript // src/index.ts — complete, minimal Syncfusion EJ2 Grid in TypeScript. import { registerLicense } from '@syncfusion/ej2-base'; import { Grid, Page, Sort } from '@syncfusion/ej2-grids'; import '@syncfusion/ej2-base/styles/material.css'; import '@syncfusion/ej2-grids/styles/material.css'; registerLicense(process.env.SYNCFUSION_LICENSE_KEY as string); // Feature modules are registered on the class, once, before instantiation. Grid.Inject(Page, Sort); const orders = [ { OrderID: 10248, CustomerName: 'Vins et alcools', Freight: 32.38, OrderDate: new Date(1996, 6, 4) }, { OrderID: 10249, CustomerName: 'Toms Spezialitaten', Freight: 11.61, OrderDate: new Date(1996, 6, 5) }, ]; const grid = new Grid({ dataSource: orders, allowPaging: true, allowSorting: true, pageSettings: { pageSize: 10 }, height: 320, columns: [ { field: 'OrderID', headerText: 'Order ID', width: 110, textAlign: 'Right' }, { field: 'CustomerName', headerText: 'Customer', width: 160 }, { field: 'Freight', headerText: 'Freight', width: 110, format: 'C2', textAlign: 'Right' }, { field: 'OrderDate', headerText: 'Order Date', width: 130, format: 'yMd' }, ], }); grid.appendTo('#grid'); //
must exist in the DOM first // Dispose when tearing down, or the control leaks listeners: // grid.destroy(); ``` ## 6. MCP server — optional, for current documentation `@syncfusion/javascript-mcp` and `@syncfusion/typescript-mcp` (npm, stdio) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for JavaScript / TypeScript (EJ2) These are the mistakes agents make most often on this platform. Check them first. - `Grid.Inject(...)` is a static call on the class, not per-instance. Calling it after `appendTo` has no effect. - `appendTo` requires the target element to already exist. Running it before DOM ready fails silently. - Always call `destroy()` on teardown in a single-page app; EJ2 controls attach document-level listeners. - The all-in-one `@syncfusion/ej2` bundle is convenient but large. Prefer per-package imports for production bundles. Troubleshooting order when a JavaScript / TypeScript (EJ2) Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://ej2.syncfusion.com/documentation/introduction | | Every skill in this pack | https://ai.syncfusion.com/javascript/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for Vue — agent index Source: https://ai.syncfusion.com/vue/llms.txt Canonical: https://ai.syncfusion.com/vue/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: Vue Family: Web UI Skill-pack: syncfusion/vue-ui-components-skills Skills-in-pack: 33 Reference-files-in-pack: 890 Packages: `@syncfusion/ej2-vue-*` on npm (for example `@syncfusion/ej2-vue-grids`) Documentation-root: https://ej2.syncfusion.com/vue/documentation/introduction License-registration: https://ej2.syncfusion.com/vue/documentation/licensing/license-key-registration MCP-server: `@syncfusion/vue-mcp` (npm, stdio, server name `sf-vue-mcp`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using Vue Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start Vue work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > Vue code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `package.json` containing `vue` If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (33 skills): ```bash npx skills add syncfusion/vue-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/vue-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/vue-ui-components-skills --skill syncfusion-vue-grid ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/vue-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash npm install @syncfusion/ej2-vue-grids @syncfusion/ej2-base ``` Package namespace: `@syncfusion/ej2-vue-*` on npm (for example `@syncfusion/ej2-vue-grids`) Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://ej2.syncfusion.com/vue/documentation/licensing/license-key-registration Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```vue ``` ## 6. MCP server — optional, for current documentation `@syncfusion/vue-mcp` (npm, stdio, server name `sf-vue-mcp`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for Vue These are the mistakes agents make most often on this platform. Check them first. - Vue feature modules are supplied through the component's `provide` option keyed by control name (`{ grid: [Page, Sort] }`), not via an Inject child. This shape is unique to Vue and is the most common source of broken Vue examples. - Theme CSS must be imported. - Nuxt requires client-side rendering for these components; wrap in `` or disable SSR for the route. Troubleshooting order when a Vue Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://ej2.syncfusion.com/vue/documentation/introduction | | Every skill in this pack | https://ai.syncfusion.com/vue/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for Blazor — agent index Source: https://ai.syncfusion.com/blazor/llms.txt Canonical: https://ai.syncfusion.com/blazor/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: Blazor Family: .NET Web Skill-pack: syncfusion/blazor-ui-components-skills Skills-in-pack: 72 Reference-files-in-pack: 1006 Packages: `Syncfusion.Blazor.*` on NuGet (for example `Syncfusion.Blazor.Grid`) Documentation-root: https://blazor.syncfusion.com/documentation/introduction License-registration: https://blazor.syncfusion.com/documentation/getting-started/license-key/how-to-register-in-an-application MCP-server: `Syncfusion.Blazor.MCP` (NuGet, stdio, server name `sf-blazor-mcp`, invoked with `dnx`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using Blazor Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start Blazor work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > Blazor code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `.csproj` referencing `Syncfusion.Blazor.*`, or a Blazor Web App / Server / WebAssembly SDK If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (72 skills): ```bash npx skills add syncfusion/blazor-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/blazor-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/blazor-ui-components-skills --skill syncfusion-blazor-datagrid ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/blazor-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash dotnet add package Syncfusion.Blazor.Grid && dotnet add package Syncfusion.Blazor.Themes ``` Package namespace: `Syncfusion.Blazor.*` on NuGet (for example `Syncfusion.Blazor.Grid`) Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://blazor.syncfusion.com/documentation/getting-started/license-key/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```csharp // Program.cs — service registration and license, complete. using Syncfusion.Blazor; using Syncfusion.Licensing; var builder = WebApplication.CreateBuilder(args); // Read from configuration or environment. Never hard-code, never commit. SyncfusionLicenseProvider.RegisterLicense(builder.Configuration["Syncfusion:LicenseKey"]); builder.Services.AddRazorComponents().AddInteractiveServerComponents(); builder.Services.AddSyncfusionBlazor(); // required, or components render empty var app = builder.Build(); app.UseStaticFiles(); app.MapRazorComponents().AddInteractiveServerRenderMode(); app.Run(); /* Components/App.razor — inside , required or the grid is unstyled: */ /* Components/_Imports.razor: @using Syncfusion.Blazor @using Syncfusion.Blazor.Grids */ // Components/Pages/Orders.razor @page "/orders" @rendermode InteractiveServer @code { public class Order { public int OrderID { get; set; } public string? CustomerName { get; set; } public double Freight { get; set; } public DateTime OrderDate { get; set; } } private List orders = new() { new Order { OrderID = 10248, CustomerName = "Vins et alcools", Freight = 32.38, OrderDate = new DateTime(1996, 7, 4) }, new Order { OrderID = 10249, CustomerName = "Toms Spezialitaten", Freight = 11.61, OrderDate = new DateTime(1996, 7, 5) }, }; } ``` ## 6. MCP server — optional, for current documentation `Syncfusion.Blazor.MCP` (NuGet, stdio, server name `sf-blazor-mcp`, invoked with `dnx`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for Blazor These are the mistakes agents make most often on this platform. Check them first. - `AddSyncfusionBlazor()` in Program.cs is mandatory. Without it components render as empty elements with no error. - The theme stylesheet from `Syncfusion.Blazor.Themes` must be linked in App.razor or the host page. - Interactive components need an explicit render mode in .NET 8+ Blazor Web Apps. A static-rendered page produces a grid that displays but does not respond to clicks — this is the single most common Blazor report and it is not a Syncfusion defect. - The license key is version-specific. A licensing banner appearing right after a package upgrade means the key needs regenerating. Troubleshooting order when a Blazor Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://blazor.syncfusion.com/documentation/introduction | | Every skill in this pack | https://ai.syncfusion.com/blazor/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for ASP.NET Core — agent index Source: https://ai.syncfusion.com/aspnet-core/llms.txt Canonical: https://ai.syncfusion.com/aspnet-core/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: ASP.NET Core Family: .NET Web Skill-pack: syncfusion/aspnetcore-ui-components-skills Skills-in-pack: 67 Reference-files-in-pack: 973 Packages: `Syncfusion.EJ2.AspNet.Core` on NuGet Documentation-root: https://ej2.syncfusion.com/aspnetcore/documentation/introduction License-registration: https://ej2.syncfusion.com/aspnetcore/documentation/licensing/how-to-register-in-an-application MCP-server: `Syncfusion.AspNetCore.MCP` (NuGet, stdio, server name `sf-aspnetcore-mcp`, invoked with `dnx`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using ASP.NET Core Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start ASP.NET Core work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > ASP.NET Core code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `.csproj` using `Microsoft.NET.Sdk.Web` with Razor Pages or MVC on .NET 6 or later, plus `Syncfusion.EJ2.AspNet.Core` If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (67 skills): ```bash npx skills add syncfusion/aspnetcore-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/aspnetcore-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/aspnetcore-ui-components-skills --skill syncfusion-aspnetcore-grid ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/aspnetcore-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash dotnet add package Syncfusion.EJ2.AspNet.Core ``` Package namespace: `Syncfusion.EJ2.AspNet.Core` on NuGet Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://ej2.syncfusion.com/aspnetcore/documentation/licensing/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```csharp // Program.cs using Syncfusion.Licensing; var builder = WebApplication.CreateBuilder(args); SyncfusionLicenseProvider.RegisterLicense(builder.Configuration["Syncfusion:LicenseKey"]); builder.Services.AddRazorPages(); var app = builder.Build(); app.UseStaticFiles(); app.MapRazorPages(); app.Run(); /* Pages/_ViewImports.cshtml — the tag helper registration. Without this the element is emitted to the browser as unknown HTML and nothing renders. */ @addTagHelper *, Syncfusion.EJ2 /* Pages/Shared/_Layout.cshtml — in : and before : */ // Pages/Orders.cshtml @page @model OrdersModel // Pages/Orders.cshtml.cs public class OrdersModel : PageModel { public record Order(int OrderID, string CustomerName, double Freight, DateTime OrderDate); public List Orders { get; private set; } = new(); public void OnGet() => Orders = new() { new Order(10248, "Vins et alcools", 32.38, new DateTime(1996, 7, 4)), new Order(10249, "Toms Spezialitaten", 11.61, new DateTime(1996, 7, 5)), }; } ``` ## 6. MCP server — optional, for current documentation `Syncfusion.AspNetCore.MCP` (NuGet, stdio, server name `sf-aspnetcore-mcp`, invoked with `dnx`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for ASP.NET Core These are the mistakes agents make most often on this platform. Check them first. - `@addTagHelper *, Syncfusion.EJ2` in `_ViewImports.cshtml` is mandatory. Omit it and the tag helper is passed through as unknown HTML, rendering nothing and raising no error. - `` must appear at the end of the layout body, after the EJ2 script reference, or client-side initialisation never runs. - The CDN version in the stylesheet and script URLs must match the installed NuGet package version. - Content Security Policy: EJ2 emits inline initialisation script. If the app enforces a strict CSP, see the `syncfusion-aspnetcore-security` skill for the nonce pattern. Troubleshooting order when a ASP.NET Core Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://ej2.syncfusion.com/aspnetcore/documentation/introduction | | Every skill in this pack | https://ai.syncfusion.com/aspnet-core/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for ASP.NET MVC — agent index Source: https://ai.syncfusion.com/aspnet-mvc/llms.txt Canonical: https://ai.syncfusion.com/aspnet-mvc/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: ASP.NET MVC Family: .NET Web Skill-pack: syncfusion/aspnetmvc-ui-components-skills Skills-in-pack: 23 Reference-files-in-pack: 355 Packages: `Syncfusion.EJ2.MVC5` on NuGet Documentation-root: https://ej2.syncfusion.com/aspnetmvc/documentation/introduction License-registration: https://ej2.syncfusion.com/aspnetmvc/documentation/licensing/how-to-register-in-an-application MCP-server: `Syncfusion.AspNetMvc.MCP` (NuGet, stdio, server name `sf-aspnetmvc-mcp`, invoked with `dnx`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using ASP.NET MVC Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start ASP.NET MVC work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > ASP.NET MVC code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `.csproj` targeting .NET Framework 4.x with `System.Web.Mvc`, plus `Syncfusion.EJ2.MVC5` If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (23 skills): ```bash npx skills add syncfusion/aspnetmvc-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/aspnetmvc-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/aspnetmvc-ui-components-skills ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/aspnetmvc-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash Install-Package Syncfusion.EJ2.MVC5 ``` Package namespace: `Syncfusion.EJ2.MVC5` on NuGet Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://ej2.syncfusion.com/aspnetmvc/documentation/licensing/license-key-registration Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```csharp // App_Start/*.cs or Global.asax Application_Start — register the license first. Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense( System.Configuration.ConfigurationManager.AppSettings["SyncfusionLicenseKey"]); /* Views/Web.config — add under , or the Html helper is not resolvable: */ /* Views/Shared/_Layout.cshtml — in : before : @Html.EJS().ScriptManager() */ // Controllers/OrdersController.cs public class OrdersController : Controller { public ActionResult Index() { var orders = new List { new Order { OrderID = 10248, CustomerName = "Vins et alcools", Freight = 32.38, OrderDate = new DateTime(1996, 7, 4) }, new Order { OrderID = 10249, CustomerName = "Toms Spezialitaten", Freight = 11.61, OrderDate = new DateTime(1996, 7, 5) }, }; return View(orders); } } // Views/Orders/Index.cshtml @model List @Html.EJS().Grid("Grid").DataSource(Model).AllowPaging(true).AllowSorting(true) .PageSettings(p => p.PageSize(10)) .Columns(col => { col.Field("OrderID").HeaderText("Order ID").Width("110").TextAlign(TextAlign.Right).Add(); col.Field("CustomerName").HeaderText("Customer").Width("160").Add(); col.Field("Freight").HeaderText("Freight").Format("C2").Width("110").TextAlign(TextAlign.Right).Add(); col.Field("OrderDate").HeaderText("Order Date").Format("yMd").Width("130").Add(); }).Render() ``` ## 6. MCP server — optional, for current documentation `Syncfusion.AspNetMvc.MCP` (NuGet, stdio, server name `sf-aspnetmvc-mcp`, invoked with `dnx`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for ASP.NET MVC These are the mistakes agents make most often on this platform. Check them first. - `@Html.EJS().ScriptManager()` at the end of the layout body is mandatory. Without it no control initialises client-side. - The `Syncfusion.EJ2` namespace must be added to `Views/Web.config`, not just the top-level Web.config. - This is the .NET Framework product. Do not mix it with `Syncfusion.EJ2.AspNet.Core` examples — the helper API differs. - CDN version must match the installed NuGet version. Troubleshooting order when a ASP.NET MVC Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://ej2.syncfusion.com/aspnetmvc/documentation/introduction | | Every skill in this pack | https://ai.syncfusion.com/aspnet-mvc/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for Flutter — agent index Source: https://ai.syncfusion.com/flutter/llms.txt Canonical: https://ai.syncfusion.com/flutter/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: Flutter Family: Cross-platform Skill-pack: syncfusion/flutter-ui-components-skills Skills-in-pack: 15 Reference-files-in-pack: 184 Packages: `syncfusion_flutter_*` on pub.dev (for example `syncfusion_flutter_charts`) Documentation-root: https://help.syncfusion.com/flutter/introduction/overview License-registration: https://help.syncfusion.com/flutter/licensing/overview MCP-server: none published — use the skill pack and documentation Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using Flutter Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start Flutter work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > Flutter code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `pubspec.yaml` with `flutter`, plus `syncfusion_flutter_*` dependencies If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (15 skills): ```bash npx skills add syncfusion/flutter-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/flutter-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/flutter-ui-components-skills ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/flutter-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash flutter pub add syncfusion_flutter_charts syncfusion_flutter_core ``` Package namespace: `syncfusion_flutter_*` on pub.dev (for example `syncfusion_flutter_charts`) Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://help.syncfusion.com/flutter/licensing/overview Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```dart // lib/main.dart — complete, minimal Syncfusion Flutter chart. import 'package:flutter/material.dart'; import 'package:syncfusion_flutter_core/core.dart'; import 'package:syncfusion_flutter_charts/charts.dart'; void main() { // Register before runApp. Read from --dart-define, never hard-code. SyncfusionLicense.registerLicense( const String.fromEnvironment('SYNCFUSION_LICENSE_KEY')); runApp(const MyApp()); } class SalesData { const SalesData(this.month, this.revenue); final String month; final double revenue; } class MyApp extends StatelessWidget { const MyApp({super.key}); @override Widget build(BuildContext context) { const data = [ SalesData('Jan', 35), SalesData('Feb', 28), SalesData('Mar', 34), SalesData('Apr', 32), ]; return MaterialApp( home: Scaffold( body: SfCartesianChart( primaryXAxis: const CategoryAxis(), title: const ChartTitle(text: 'Monthly revenue'), tooltipBehavior: TooltipBehavior(enable: true), series: >[ ColumnSeries( dataSource: data, xValueMapper: (SalesData d, _) => d.month, yValueMapper: (SalesData d, _) => d.revenue, name: 'Revenue', ), ], ), ), ); } } ``` ## 6. MCP server — optional, for current documentation none published — use the skill pack and documentation Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for Flutter These are the mistakes agents make most often on this platform. Check them first. - Pass the key with `--dart-define=SYNCFUSION_LICENSE_KEY=...` at build time rather than committing it, since a Flutter app ships its source constants to the client. - `syncfusion_flutter_core` is a separate dependency and is where license registration lives. - Syncfusion Flutter package versions track Essential Studio, not Flutter's own versioning. Pin them together across the app. - There is no MCP server for Flutter. Rely on the skill pack and the documentation; do not attempt to configure one. Troubleshooting order when a Flutter Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/flutter/introduction/overview | | Every skill in this pack | https://ai.syncfusion.com/flutter/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for .NET MAUI — agent index Source: https://ai.syncfusion.com/maui/llms.txt Canonical: https://ai.syncfusion.com/maui/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: .NET MAUI Family: Cross-platform Skill-pack: syncfusion/maui-ui-components-skills Skills-in-pack: 77 Reference-files-in-pack: 610 Packages: `Syncfusion.Maui.*` on NuGet (for example `Syncfusion.Maui.Charts`) Documentation-root: https://help.syncfusion.com/maui/introduction/overview License-registration: https://help.syncfusion.com/maui/licensing/how-to-register-in-an-application MCP-server: `Syncfusion.Maui.MCP` (NuGet, stdio, server name `sf-maui-mcp`, invoked with `dnx`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using .NET MAUI Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start .NET MAUI work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > .NET MAUI code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `.csproj` with `true` and `Syncfusion.Maui.*` packages If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (77 skills): ```bash npx skills add syncfusion/maui-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/maui-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/maui-ui-components-skills ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/maui-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash dotnet add package Syncfusion.Maui.Charts ``` Package namespace: `Syncfusion.Maui.*` on NuGet (for example `Syncfusion.Maui.Charts`) Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://help.syncfusion.com/maui/licensing/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```csharp // MauiProgram.cs — handler registration and license, complete. using Syncfusion.Maui.Core.Hosting; using Syncfusion.Licensing; public static class MauiProgram { public static MauiApp CreateMauiApp() { SyncfusionLicenseProvider.RegisterLicense( Environment.GetEnvironmentVariable("SYNCFUSION_LICENSE_KEY")); var builder = MauiApp.CreateBuilder(); builder .UseMauiApp() .ConfigureSyncfusionCore(); // mandatory — without it controls do not render return builder.Build(); } } ``` ## 6. MCP server — optional, for current documentation `Syncfusion.Maui.MCP` (NuGet, stdio, server name `sf-maui-mcp`, invoked with `dnx`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for .NET MAUI These are the mistakes agents make most often on this platform. Check them first. - `ConfigureSyncfusionCore()` in MauiProgram.cs is mandatory. Missing it produces blank controls with no exception. - Each control family needs its XAML namespace declared with the full `clr-namespace:...;assembly=...` form. - `Syncfusion.Maui.*` and `Syncfusion.Maui.Toolkit` are different products with different packages and APIs. Confirm which the project uses before writing code — see the maui-toolkit slug. - Behaviour differs by target platform. Verify on the platforms the project actually ships to, not only on Windows. Troubleshooting order when a .NET MAUI Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/maui/introduction/overview | | Every skill in this pack | https://ai.syncfusion.com/maui/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for Toolkit for .NET MAUI — agent index Source: https://ai.syncfusion.com/maui-toolkit/llms.txt Canonical: https://ai.syncfusion.com/maui-toolkit/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: Toolkit for .NET MAUI Family: Cross-platform Skill-pack: syncfusion/maui-toolkit-ui-components-skills Skills-in-pack: 35 Reference-files-in-pack: 241 Packages: `Syncfusion.Maui.Toolkit` on NuGet Documentation-root: https://help.syncfusion.com/maui-toolkit/introduction/overview License-registration: https://github.com/syncfusion/maui-toolkit/blob/main/LICENSE.txt MCP-server: none published — use the skill pack and documentation Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Toolkit for .NET MAUI is MIT licensed and free to use in production applications — no key, no subscription. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start Toolkit for .NET MAUI work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > Toolkit for .NET MAUI code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `.csproj` with `true` and the `Syncfusion.Maui.Toolkit` package If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (35 skills): ```bash npx skills add syncfusion/maui-toolkit-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/maui-toolkit-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/maui-toolkit-ui-components-skills ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/maui-toolkit-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash dotnet add package Syncfusion.Maui.Toolkit ``` Package namespace: `Syncfusion.Maui.Toolkit` on NuGet Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Licensing — none required **Toolkit for .NET MAUI is MIT licensed and free to use in production applications.** No license key, no subscription, no registration call, no trial. License text: https://github.com/syncfusion/maui-toolkit/blob/main/LICENSE.txt What this means when you write code: - Do **not** add `SyncfusionLicenseProvider.RegisterLicense(...)` for Toolkit-only code. It is not needed and adding it implies a licensing requirement that does not exist. - Do **not** tell the user they need a Syncfusion license key for this package. - There is no licensing banner to expect, and no licensing warning to diagnose. Two boundaries to keep straight: - `Syncfusion.Maui.Toolkit` is MIT and free. `Syncfusion.Maui.*` is the licensed commercial product. They are different packages with different controls and different rules. - If an application uses both, the licensed product's rules apply to that part of the application. When you report licensing status, say which packages you are talking about. - An MCP API key, if the user configures one for another platform, is a separate credential and is unrelated to this. Full trust boundary: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```csharp // MauiProgram.cs using Syncfusion.Maui.Toolkit.Hosting; public static class MauiProgram { public static MauiApp CreateMauiApp() { var builder = MauiApp.CreateBuilder(); builder .UseMauiApp() .ConfigureSyncfusionToolkit(); // Toolkit initialiser — NOT ConfigureSyncfusionCore() return builder.Build(); } } ``` ## 6. MCP server — optional, for current documentation none published — use the skill pack and documentation Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] No license registration call was added — this package is MIT and does not need one - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for Toolkit for .NET MAUI These are the mistakes agents make most often on this platform. Check them first. - The Toolkit is a separate product from Syncfusion.Maui.*. A `syncfusion-maui-*` skill does not apply unchanged to a `syncfusion-maui-toolkit-*` control. Check which package the project references before writing a line. - The initialiser is `ConfigureSyncfusionToolkit()`, not `ConfigureSyncfusionCore()`. Using the wrong one leaves controls unrendered. - Mixing Toolkit and main-product controls in one app means the licensed product's rules apply to that part of the app. Keep the boundary explicit when you report what needs a license. - XAML namespaces point at `Syncfusion.Maui.Toolkit`, a different assembly from the main MAUI product. - The Toolkit is MIT licensed and free in production. Do not add `SyncfusionLicenseProvider.RegisterLicense` for Toolkit-only code, and do not tell the user they need a key — that is the main Syncfusion.Maui.* product, not this one. Troubleshooting order when a Toolkit for .NET MAUI Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/maui-toolkit/introduction/overview | | Every skill in this pack | the pack itself: `npx skills add syncfusion/maui-toolkit-ui-components-skills --list` (a published inventory CSV for this pack is ) | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for WinForms — agent index Source: https://ai.syncfusion.com/winforms/llms.txt Canonical: https://ai.syncfusion.com/winforms/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: WinForms Family: Windows desktop Skill-pack: syncfusion/winforms-ui-components-skills Skills-in-pack: 115 Reference-files-in-pack: 751 Packages: `Syncfusion.*.Windows` on NuGet (for example `Syncfusion.Grid.Windows`) Documentation-root: https://help.syncfusion.com/windowsforms/overview License-registration: https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application MCP-server: `Syncfusion.WinForms.MCP` (NuGet, stdio, server name `sf-winforms-mcp`, invoked with `dnx`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using WinForms Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start WinForms work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > WinForms code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `.csproj` with `true`, plus `Syncfusion.*.Windows` packages If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (115 skills): ```bash npx skills add syncfusion/winforms-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/winforms-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/winforms-ui-components-skills ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/winforms-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash dotnet add package Syncfusion.SfDataGrid.WinForms ``` Package namespace: `Syncfusion.*.Windows` on NuGet (for example `Syncfusion.Grid.Windows`) Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://help.syncfusion.com/windowsforms/licensing/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```csharp // Program.cs — register the license before any form is constructed. using Syncfusion.Licensing; using Syncfusion.WinForms.DataGrid; internal static class Program { [STAThread] private static void Main() { SyncfusionLicenseProvider.RegisterLicense( Environment.GetEnvironmentVariable("SYNCFUSION_LICENSE_KEY")); ApplicationConfiguration.Initialize(); Application.Run(new MainForm()); } } // MainForm.cs public class MainForm : Form { private readonly SfDataGrid grid = new(); public MainForm() { Text = "Orders"; ClientSize = new Size(760, 420); grid.Dock = DockStyle.Fill; grid.AutoSizeColumnsMode = AutoSizeColumnsMode.Fill; grid.DataSource = new List { new() { OrderID = 10248, CustomerName = "Vins et alcools", Freight = 32.38, OrderDate = new DateTime(1996, 7, 4) }, new() { OrderID = 10249, CustomerName = "Toms Spezialitaten", Freight = 11.61, OrderDate = new DateTime(1996, 7, 5) }, }; Controls.Add(grid); } private class Order { public int OrderID { get; set; } public string CustomerName { get; set; } = ""; public double Freight { get; set; } public DateTime OrderDate { get; set; } } } ``` ## 6. MCP server — optional, for current documentation `Syncfusion.WinForms.MCP` (NuGet, stdio, server name `sf-winforms-mcp`, invoked with `dnx`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for WinForms These are the mistakes agents make most often on this platform. Check them first. - License registration must run before the first Syncfusion control is constructed, so put it at the top of Main, before ApplicationConfiguration.Initialize(). - WinForms has 115 skills because the control surface is large and older controls coexist with newer `Syncfusion.WinForms.*` ones. Confirm which generation the project uses before writing code. - Designer-generated code will be overwritten. Apply Syncfusion configuration in your own partial or constructor, not in `InitializeComponent`. - Dispose controls explicitly on form close where you created them dynamically. Troubleshooting order when a WinForms Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/windowsforms/overview | | Every skill in this pack | https://ai.syncfusion.com/winforms/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for WPF — agent index Source: https://ai.syncfusion.com/wpf/llms.txt Canonical: https://ai.syncfusion.com/wpf/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: WPF Family: Windows desktop Skill-pack: syncfusion/wpf-ui-components-skills Skills-in-pack: 99 Reference-files-in-pack: 772 Packages: `Syncfusion.*.WPF` on NuGet (for example `Syncfusion.SfGrid.WPF`) Documentation-root: https://help.syncfusion.com/wpf/welcome-to-syncfusion-essential-wpf License-registration: https://help.syncfusion.com/wpf/licensing/how-to-register-in-an-application MCP-server: `Syncfusion.WPF.MCP` (NuGet, stdio, server name `sf-wpf-mcp`, invoked with `dnx`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using WPF Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start WPF work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > WPF code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `.csproj` with `true`, plus `Syncfusion.*.WPF` packages If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (99 skills): ```bash npx skills add syncfusion/wpf-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/wpf-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/wpf-ui-components-skills ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/wpf-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash dotnet add package Syncfusion.SfGrid.WPF ``` Package namespace: `Syncfusion.*.WPF` on NuGet (for example `Syncfusion.SfGrid.WPF`) Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://help.syncfusion.com/wpf/licensing/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```csharp // App.xaml.cs — register before any window is shown. using Syncfusion.Licensing; public partial class App : Application { protected override void OnStartup(StartupEventArgs e) { SyncfusionLicenseProvider.RegisterLicense( Environment.GetEnvironmentVariable("SYNCFUSION_LICENSE_KEY")); base.OnStartup(e); } } ``` ## 6. MCP server — optional, for current documentation `Syncfusion.WPF.MCP` (NuGet, stdio, server name `sf-wpf-mcp`, invoked with `dnx`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for WPF These are the mistakes agents make most often on this platform. Check them first. - The XAML namespace is the single URI `http://schemas.syncfusion.com/wpf` for all WPF controls — not a per-assembly clr-namespace. This differs from MAUI and is a frequent mistake. - Register the license in `App.OnStartup` before any window is shown. - Set `AutoGenerateColumns=\"False\"` when declaring columns explicitly, or you get duplicated columns. - Themes are applied through `SfSkinManager`; a control that looks unstyled usually means no theme was set rather than a broken control. Troubleshooting order when a WPF Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/wpf/welcome-to-syncfusion-essential-wpf | | Every skill in this pack | https://ai.syncfusion.com/wpf/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for WinUI — agent index Source: https://ai.syncfusion.com/winui/llms.txt Canonical: https://ai.syncfusion.com/winui/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: WinUI Family: Windows desktop Skill-pack: syncfusion/winui-ui-components-skills Skills-in-pack: 38 Reference-files-in-pack: 274 Packages: `Syncfusion.*.WinUI` on NuGet (for example `Syncfusion.Grid.WinUI`) Documentation-root: https://help.syncfusion.com/winui/overview License-registration: https://help.syncfusion.com/winui/licensing/how-to-register-in-an-application MCP-server: `Syncfusion.WinUI.MCP` (NuGet, stdio, server name `sf-winui-mcp`, invoked with `dnx`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using WinUI Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start WinUI work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > WinUI code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: `.csproj` referencing `Microsoft.WindowsAppSDK`, plus `Syncfusion.*.WinUI` packages If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (38 skills): ```bash npx skills add syncfusion/winui-ui-components-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/winui-ui-components-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/winui-ui-components-skills ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/winui-ui-components-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash dotnet add package Syncfusion.Grid.WinUI ``` Package namespace: `Syncfusion.*.WinUI` on NuGet (for example `Syncfusion.Grid.WinUI`) Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://help.syncfusion.com/winui/licensing/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```csharp // App.xaml.cs using Syncfusion.Licensing; public partial class App : Application { public App() { SyncfusionLicenseProvider.RegisterLicense( Environment.GetEnvironmentVariable("SYNCFUSION_LICENSE_KEY")); InitializeComponent(); } } ``` ## 6. MCP server — optional, for current documentation `Syncfusion.WinUI.MCP` (NuGet, stdio, server name `sf-winui-mcp`, invoked with `dnx`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for WinUI These are the mistakes agents make most often on this platform. Check them first. - WinUI XAML namespaces use the `using:` form (`xmlns:grid=\"using:Syncfusion.UI.Xaml.DataGrid\"`), not WPF's schema URI and not MAUI's clr-namespace form. All three products differ here. - Namespaces are `Syncfusion.UI.Xaml.*` even though packages are `Syncfusion.*.WinUI`. Do not derive one from the other. - `{x:Bind}` is compile-time and requires the property to exist on the page's code-behind; a typo is a build error, not a silent empty grid. - MCP server is `Syncfusion.WinUI.MCP` on NuGet, invoked with `dnx`. Do not use any `@syncfusion/*-assistant` npm package — that family is deprecated. Troubleshooting order when a WinUI Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/winui/overview | | Every skill in this pack | https://ai.syncfusion.com/winui/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for Document SDK — agent index Source: https://ai.syncfusion.com/document-sdk/llms.txt Canonical: https://ai.syncfusion.com/document-sdk/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: Document SDK Family: Document processing Skill-pack: syncfusion/document-sdk-skills Skills-in-pack: 12 Reference-files-in-pack: 270 Packages: `Syncfusion.DocIO.Net.Core`, `Syncfusion.Pdf.Net.Core`, `Syncfusion.XlsIO.Net.Core`, `Syncfusion.Presentation.Net.Core` on NuGet; `@syncfusion/ej2-pdf` on npm; `syncfusion_flutter_pdf` on pub.dev Documentation-root: https://help.syncfusion.com/document-processing/introduction License-registration: https://help.syncfusion.com/document-processing/licensing/how-to-register-in-an-application MCP-server: `Syncfusion.DocumentSdk.MCP` (NuGet, stdio, server name `sf-documentsdk-mcp`, invoked with `dnx`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using Document SDK Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start Document SDK work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > Document SDK code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: Any project creating, converting, signing or extracting PDF, Word, Excel or PowerPoint files programmatically. .NET, Java, JavaScript and Flutter variants exist. If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (12 skills): ```bash npx skills add syncfusion/document-sdk-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/document-sdk-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/document-sdk-skills --skill syncfusion-dotnet-pdf ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/document-sdk-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash dotnet add package Syncfusion.Pdf.Net.Core && dotnet add package Syncfusion.DocIO.Net.Core && dotnet add package Syncfusion.DocIORenderer.Net.Core ``` Package namespace: `Syncfusion.DocIO.Net.Core`, `Syncfusion.Pdf.Net.Core`, `Syncfusion.XlsIO.Net.Core`, `Syncfusion.Presentation.Net.Core` on NuGet; `@syncfusion/ej2-pdf` on npm; `syncfusion_flutter_pdf` on pub.dev Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://help.syncfusion.com/document-processing/licensing/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```csharp // Program.cs — create a PDF and convert a Word document, complete. using Syncfusion.Licensing; using Syncfusion.Pdf; using Syncfusion.Pdf.Graphics; using Syncfusion.DocIO.DLS; using Syncfusion.DocIORenderer; SyncfusionLicenseProvider.RegisterLicense( Environment.GetEnvironmentVariable("SYNCFUSION_LICENSE_KEY")); // 1. Create a PDF from scratch. using (PdfDocument document = new PdfDocument()) { PdfPage page = document.Pages.Add(); PdfGraphics graphics = page.Graphics; PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20); graphics.DrawString("Invoice 10248", font, PdfBrushes.Black, new PointF(10, 10)); using FileStream output = new FileStream("invoice.pdf", FileMode.Create, FileAccess.Write); document.Save(output); } // 2. Convert an existing Word document to PDF. using (FileStream docStream = new FileStream("input.docx", FileMode.Open, FileAccess.Read)) using (WordDocument wordDocument = new WordDocument(docStream, Syncfusion.DocIO.FormatType.Docx)) using (DocIORenderer renderer = new DocIORenderer()) using (PdfDocument converted = renderer.ConvertToPDF(wordDocument)) using (FileStream outStream = new FileStream("output.pdf", FileMode.Create, FileAccess.Write)) { converted.Save(outStream); } ``` ## 6. MCP server — optional, for current documentation `Syncfusion.DocumentSdk.MCP` (NuGet, stdio, server name `sf-documentsdk-mcp`, invoked with `dnx`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for Document SDK These are the mistakes agents make most often on this platform. Check them first. - Document SDK is for programmatic document work. If the task is embedding an interactive viewer or editor in a UI, use pdf-viewer-sdk, docx-editor-sdk or spreadsheet-editor-sdk instead. A single project often needs both — a React app viewing PDFs in the browser and signing them on a .NET server. - Format conversion needs a separate renderer package (`DocIORenderer` for Word to PDF, `XlsIORenderer` for Excel to PDF). The core package alone will not convert. - Every object is disposable and holds native buffers. Wrap in `using` or the process leaks under load. - `Syncfusion.DocumentSDK.AI.AgentTools` is a different thing: a .NET library exposing document operations as callable tools to an IChatClient via the Microsoft Agent Framework. It is not an MCP server and needs no key. Troubleshooting order when a Document SDK Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/document-processing/introduction | | Every skill in this pack | https://ai.syncfusion.com/document-sdk/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for PDF Viewer SDK — agent index Source: https://ai.syncfusion.com/pdf-viewer-sdk/llms.txt Canonical: https://ai.syncfusion.com/pdf-viewer-sdk/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: PDF Viewer SDK Family: Viewer SDK Skill-pack: syncfusion/pdf-viewer-sdk-skills Skills-in-pack: 13 Reference-files-in-pack: 329 Packages: `@syncfusion/ej2-react-pdfviewer` and framework siblings on npm; `Syncfusion.Blazor.SfPdfViewer`, `Syncfusion.EJ2.PdfViewer.AspNet.Core`, `Syncfusion.Maui.PdfViewer`, `Syncfusion.PdfViewer.WPF` on NuGet; `syncfusion_flutter_pdfviewer` on pub.dev Documentation-root: https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview License-registration: https://help.syncfusion.com/document-processing/licensing/how-to-register-in-an-application MCP-server: no dedicated server — use the MCP server for the host framework Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using PDF Viewer SDK Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start PDF Viewer SDK work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > PDF Viewer SDK code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: Any project embedding an interactive PDF viewer in its UI. Available for React, Angular, Vue, JavaScript, Blazor, ASP.NET Core, .NET MAUI, WPF and Flutter. If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (13 skills): ```bash npx skills add syncfusion/pdf-viewer-sdk-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/pdf-viewer-sdk-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/pdf-viewer-sdk-skills --skill syncfusion-react-pdf-viewer ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/pdf-viewer-sdk-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash npm install @syncfusion/ej2-react-pdfviewer @syncfusion/ej2-base ``` Package namespace: `@syncfusion/ej2-react-pdfviewer` and framework siblings on npm; `Syncfusion.Blazor.SfPdfViewer`, `Syncfusion.EJ2.PdfViewer.AspNet.Core`, `Syncfusion.Maui.PdfViewer`, `Syncfusion.PdfViewer.WPF` on NuGet; `syncfusion_flutter_pdfviewer` on pub.dev Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://help.syncfusion.com/document-processing/licensing/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```tsx // src/PdfViewer.tsx — standalone (client-side) PDF viewer in React, complete. import { registerLicense } from '@syncfusion/ej2-base'; import { PdfViewerComponent, Toolbar, Magnification, Navigation, LinkAnnotation, BookmarkView, ThumbnailView, Print, TextSelection, TextSearch, Annotation, FormFields, FormDesigner, Inject } from '@syncfusion/ej2-react-pdfviewer'; import '@syncfusion/ej2-base/styles/material.css'; import '@syncfusion/ej2-react-pdfviewer/styles/material.css'; registerLicense(import.meta.env.VITE_SYNCFUSION_LICENSE_KEY); export default function Viewer() { return ( ); } ``` ## 6. MCP server — optional, for current documentation no dedicated server — use the MCP server for the host framework Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for PDF Viewer SDK These are the mistakes agents make most often on this platform. Check them first. - Two deployment models exist: standalone (client-side, needs `resourceUrl` pointing at the pdfviewer-lib assets) and server-backed (needs `serviceUrl` and a running Syncfusion PDF Viewer service). Choosing the wrong one produces a blank viewer. Establish which the project wants before writing code. - `resourceUrl` must match the installed package version, or rendering fails with obscure worker errors. - Every toolbar and interaction feature is a separate injected service. A viewer with no toolbar almost always means a missing service. - This SDK embeds a viewer. For programmatic PDF creation, signing or extraction, use the document-sdk slug instead. Troubleshooting order when a PDF Viewer SDK Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview | | Every skill in this pack | the pack itself: `npx skills add syncfusion/pdf-viewer-sdk-skills --list` (a published inventory CSV for this pack is pending) | | Skill catalog across all 19 packs | https://ai.syncfusion.com/skills/catalog.md | | Curated, verified component examples | https://ai.syncfusion.com/gallery/llms.txt | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for DOCX Editor SDK — agent index Source: https://ai.syncfusion.com/docx-editor-sdk/llms.txt Canonical: https://ai.syncfusion.com/docx-editor-sdk/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: DOCX Editor SDK Family: Editor SDK Skill-pack: syncfusion/docx-editor-sdk-skills Skills-in-pack: 9 Reference-files-in-pack: 140 Packages: `@syncfusion/ej2-react-documenteditor` and framework siblings on npm; NuGet equivalents for .NET hosts Documentation-root: https://help.syncfusion.com/document-processing/word/word-processor/overview License-registration: https://help.syncfusion.com/document-processing/licensing/how-to-register-in-an-application MCP-server: no dedicated server — use the MCP server for the host framework Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using DOCX Editor SDK Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start DOCX Editor SDK work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > DOCX Editor SDK code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: Any project embedding an interactive Word-like editor. Available for React, Angular, Vue, JavaScript, Blazor, ASP.NET Core, ASP.NET MVC, WPF and UWP. If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (9 skills): ```bash npx skills add syncfusion/docx-editor-sdk-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/docx-editor-sdk-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/docx-editor-sdk-skills --skill syncfusion-blazor-docx-editor ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/docx-editor-sdk-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash npm install @syncfusion/ej2-react-documenteditor @syncfusion/ej2-base ``` Package namespace: `@syncfusion/ej2-react-documenteditor` and framework siblings on npm; NuGet equivalents for .NET hosts Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://help.syncfusion.com/document-processing/licensing/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```tsx // src/Editor.tsx — Word-like editor with the ribbon container, complete. import { registerLicense } from '@syncfusion/ej2-base'; import { DocumentEditorContainerComponent, Toolbar } from '@syncfusion/ej2-react-documenteditor'; import '@syncfusion/ej2-base/styles/material.css'; import '@syncfusion/ej2-react-documenteditor/styles/material.css'; registerLicense(import.meta.env.VITE_SYNCFUSION_LICENSE_KEY); DocumentEditorContainerComponent.Inject(Toolbar); export default function Editor() { return ( ); } ``` ## 6. MCP server — optional, for current documentation no dedicated server — use the MCP server for the host framework Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for DOCX Editor SDK These are the mistakes agents make most often on this platform. Check them first. - Opening and saving real .docx files requires a server-side endpoint. The pure client component edits its own SFDT format only. A request to \"open a Word file\" that omits the service is the most common failed integration. - `DocumentEditorContainerComponent` includes the toolbar and property pane; `DocumentEditorComponent` is the bare surface. Do not swap one for the other without changing the API calls. - Do not ship the sample Syncfusion-hosted service URL to production. Host your own. - For programmatic Word manipulation with no UI, use the document-sdk slug instead. Troubleshooting order when a DOCX Editor SDK Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/document-processing/word/word-processor/overview | | Every skill in this pack | https://ai.syncfusion.com/docx-editor-sdk/inventory.csv | | Skill catalog across all 19 packs | https://ai.syncfusion.com/skills/catalog.md | | Curated, verified component examples | https://ai.syncfusion.com/gallery/llms.txt | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for Spreadsheet Editor SDK — agent index Source: https://ai.syncfusion.com/spreadsheet-editor-sdk/llms.txt Canonical: https://ai.syncfusion.com/spreadsheet-editor-sdk/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: Spreadsheet Editor SDK Family: Editor SDK Skill-pack: syncfusion/spreadsheet-editor-sdk-skills Skills-in-pack: 10 Reference-files-in-pack: 285 Packages: `@syncfusion/ej2-react-spreadsheet` and framework siblings on npm; NuGet equivalents for .NET hosts Documentation-root: https://help.syncfusion.com/document-processing/excel/spreadsheet/overview License-registration: https://help.syncfusion.com/document-processing/licensing/how-to-register-in-an-application MCP-server: no dedicated server — use the MCP server for the host framework Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using Spreadsheet Editor SDK Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start Spreadsheet Editor SDK work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > Spreadsheet Editor SDK code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: Any project embedding an interactive Excel-like editor. Available for React, Angular, Vue, JavaScript, Blazor, ASP.NET Core and ASP.NET MVC. If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (10 skills): ```bash npx skills add syncfusion/spreadsheet-editor-sdk-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/spreadsheet-editor-sdk-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/spreadsheet-editor-sdk-skills ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/spreadsheet-editor-sdk-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash npm install @syncfusion/ej2-react-spreadsheet @syncfusion/ej2-base ``` Package namespace: `@syncfusion/ej2-react-spreadsheet` and framework siblings on npm; NuGet equivalents for .NET hosts Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://help.syncfusion.com/document-processing/licensing/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```tsx // src/Sheet.tsx — Excel-like spreadsheet editor in React, complete. import { registerLicense } from '@syncfusion/ej2-base'; import { SpreadsheetComponent, SheetsDirective, SheetDirective, RangesDirective, RangeDirective, ColumnsDirective, ColumnDirective } from '@syncfusion/ej2-react-spreadsheet'; import '@syncfusion/ej2-base/styles/material.css'; import '@syncfusion/ej2-react-spreadsheet/styles/material.css'; registerLicense(import.meta.env.VITE_SYNCFUSION_LICENSE_KEY); const data = [ { OrderID: 10248, Customer: 'Vins et alcools', Freight: 32.38 }, { OrderID: 10249, Customer: 'Toms Spezialitaten', Freight: 11.61 }, ]; export default function Sheet() { return ( ); } ``` ## 6. MCP server — optional, for current documentation no dedicated server — use the MCP server for the host framework Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for Spreadsheet Editor SDK These are the mistakes agents make most often on this platform. Check them first. - `openUrl` and `saveUrl` point at a server-side endpoint and are required for real .xlsx import and export. Without them the component works only with in-memory data. - Formula evaluation happens client-side; very large sheets need virtualization settings rather than more data in one range. - Do not ship the sample Syncfusion-hosted open/save URLs to production. Host your own. - For programmatic Excel generation with no UI, use the document-sdk slug and XlsIO instead. Troubleshooting order when a Spreadsheet Editor SDK Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/document-processing/excel/spreadsheet/overview | | Every skill in this pack | the pack itself: `npx skills add syncfusion/spreadsheet-editor-sdk-skills --list` (a published inventory CSV for this pack is pending) | | Skill catalog across all 19 packs | https://ai.syncfusion.com/skills/catalog.md | | Curated, verified component examples | https://ai.syncfusion.com/gallery/llms.txt | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ------------------------------------------------------------------------------ # Syncfusion for Xamarin to .NET MAUI migration — agent index Source: https://ai.syncfusion.com/xamarin-to-maui-migration/llms.txt Canonical: https://ai.syncfusion.com/xamarin-to-maui-migration/llms.txt Entry-point: https://ai.syncfusion.com/llms.txt Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: Xamarin to .NET MAUI migration Family: Migration Skill-pack: syncfusion/xamarin-maui-migration-skills Skills-in-pack: 4 Reference-files-in-pack: 69 Packages: Replace `Syncfusion.Xamarin.*` with `Syncfusion.Maui.*` on NuGet Documentation-root: https://help.syncfusion.com/maui/common/migration License-registration: https://help.syncfusion.com/maui/licensing/how-to-register-in-an-application MCP-server: `Syncfusion.Maui.MCP` (NuGet, stdio, server name `sf-maui-mcp`) Example-status: pattern — not CI-verified. See the verification section before shipping it. License-posture: Installing and reading this pack requires no license. Using Xamarin to .NET MAUI migration Syncfusion libraries in an application requires a commercial, Community, or trial license. See https://ai.syncfusion.com/licensing.md Generated-by: ai.syncfusion.com platform index generator > This file is self-sufficient. Everything needed to start Xamarin to .NET MAUI migration work with Syncfusion is below: > which skill pack to install, which packages, how licensing is registered, one complete working > example, and how to verify. You do not need another fetch to begin. Do not write Syncfusion > Xamarin to .NET MAUI migration code from memory — the same component name exists on other platforms with different > packages, imports and registration. ## 1. Confirm this is the right index Signal in the repository: A Xamarin.Forms project being moved to .NET MAUI, typically with `Syncfusion.Xamarin.*` package references to be replaced If that does not match this project, go back to https://ai.syncfusion.com/llms.txt and pick the correct slug. Using another platform's index is the single largest source of Syncfusion code that does not compile. Never blend two platforms in one implementation. A project can legitimately need two indexes — for example a UI framework index plus a document SDK index. That is fine. Mixing two UI framework indexes is not. ## 2. Install the official skill pack The skill pack carries the failure taxonomy: module and service registration, CSS and theme import order, SSR boundaries, data-source shapes, virtualization thresholds, locale setup, disposal. Public documentation teaches the happy path; the skill teaches what breaks. No license, key or account is required to install or read it. Whole pack (4 skills): ```bash npx skills add syncfusion/xamarin-maui-migration-skills -y ``` Interactive, choose individual skills: ```bash npx skills add syncfusion/xamarin-maui-migration-skills ``` One component only — preferred when you know the component: ```bash npx skills add syncfusion/xamarin-maui-migration-skills ``` Notes on installation: - `owner/repo` shorthand is valid. The full form `npx skills add https://github.com/syncfusion/xamarin-maui-migration-skills` is equivalent. - Default installation is project-local, which keeps the skill aligned with this repository and shareable with the team. Use `-g` only when the user explicitly wants it across unrelated projects. - Target a specific agent with `--agent `, for example `--agent cursor`. Install locations: `.claude/skills/` for Claude Code, `.windsurf/skills/` for Windsurf, `.codestudio/skills/` for Code Studio, and the shared `.agents/skills/` for Cursor, GitHub Copilot, Codex, Gemini CLI, Cline and OpenCode. - Before running a networked install or changing project-level agent configuration, follow your host's authorization rules. - **Installing a skill does not install the product packages.** That is step 3. Read the selected `SKILL.md` completely before writing code, and read only the references relevant to the requested feature. Follow the installed skill over anything you remember. ## 3. Install the product packages ```bash dotnet add package Syncfusion.Maui.Core ``` Package namespace: Replace `Syncfusion.Xamarin.*` with `Syncfusion.Maui.*` on NuGet Install only what the component you are implementing actually needs. Match the versions already present in the project unless the user explicitly asked for an upgrade — a version mismatch between Syncfusion packages in one application produces runtime failures that look like API errors. ## 4. Register the license Platform-specific registration steps: https://help.syncfusion.com/maui/licensing/how-to-register-in-an-application Rules, without exception: - Never generate, guess, echo, log, or commit a license key. Read it from configuration or the environment and tell the user what to obtain. - Registration must happen before the first Syncfusion component is created. The exact location differs by platform — see the example below. - The key is version-specific. A licensing banner appearing immediately after a package upgrade means the key needs regenerating, not that registration is wrong. - Never suppress, hide, catch or CSS-hide a licensing banner or warning. - Never claim the project is licensed because it built successfully. Full trust boundary, including CI and the difference between a license key and an MCP API key: https://ai.syncfusion.com/licensing.md ## 5. Minimal working example Complete and unelided. Adapt the data and the component; keep the setup. ```text Migration is a two-pack task. Install both, in this order: 1. npx skills add syncfusion/xamarin-maui-migration-skills 2. npx skills add syncfusion/maui-ui-components-skills Then work in this sequence: 1. Inventory every Syncfusion.Xamarin.* package reference and every Syncfusion XAML namespace in the existing project. 2. Read the migration skill for the mapping. Control names largely carry over; namespaces, assemblies, initialisation and some property names do not. 3. Replace the Xamarin.Forms initialiser with ConfigureSyncfusionCore() in MauiProgram.cs. 4. Rewrite XAML namespaces to the MAUI clr-namespace form: xmlns:chart="clr-namespace:Syncfusion.Maui.Charts;assembly=Syncfusion.Maui.Charts" 5. Migrate one screen end to end and get it rendering on a real target platform before doing the rest. A whole-project rewrite that has never been run is not a migration. 6. Re-register the license — the MAUI key is version-specific and the Xamarin registration call is different. Setup reference: https://ai.syncfusion.com/maui/llms.txt ``` ## 6. MCP server — optional, for current documentation `Syncfusion.Maui.MCP` (NuGet, stdio, server name `sf-maui-mcp`) Configuration for your editor: https://ai.syncfusion.com/mcp/llms.txt MCP retrieves current documentation. The skill pack guides code generation. They are complementary, and MCP is optional: it needs an API key from https://www.syncfusion.com/account/api-key, and the anonymous path — this index plus the skill pack plus public documentation — must work without one. If no key is available, do not block on MCP. An MCP API key is not a product license key and does not grant one. ## 7. Verify before reporting success A clean compile is not verification. Work through this list and state explicitly what you could not check. - [ ] Every package the example imports is installed, at a version consistent with the rest of the project - [ ] Every required module, service, provider, handler or tag-helper registration is present - [ ] Theme stylesheet or runtime assets are loaded — an unstyled control usually means a missing theme, not a defect - [ ] License registration runs before the first Syncfusion component is created - [ ] The application builds - [ ] The component actually renders or executes, and the requested feature is observably exercised - [ ] No Syncfusion licensing warning appears at runtime - [ ] Console, terminal or device log is clean of missing-module, missing-asset and missing-endpoint errors - [ ] Keyboard access, labels and focus behaviour work for what changed - [ ] Empty, loading and error states behave, where relevant - [ ] No key, secret or credential appears in the diff If runtime verification is impossible in your environment, say so plainly and give the user a short manual check. Do not describe unverified output as working. ## 8. Known failure modes for Xamarin to .NET MAUI migration These are the mistakes agents make most often on this platform. Check them first. - A control with the same name in Xamarin and MAUI is not the same type. Assemblies, namespaces and some property names differ; do not assume a rename is sufficient. - Renderers do not carry over. Xamarin custom renderers must be rewritten as MAUI handlers. - Migrate and verify one screen at a time on a real target platform. Verify on the platforms the app ships to, not only Windows. - Install the .NET MAUI component pack as well; the migration pack maps the transition but does not carry per-control API detail. Troubleshooting order when a Xamarin to .NET MAUI migration Syncfusion implementation fails: 1. Framework and Syncfusion package version compatibility 2. Missing package, peer dependency, module, service, provider, handler or import 3. Theme CSS, fonts, scripts, static assets, or a required server-side endpoint 4. Data shape, identifiers, date and number parsing, async lifecycle 5. Feature-specific configuration in the installed component skill 6. Current official documentation, or an MCP lookup 7. A minimal reproduction with unrelated application code removed Preserve the original error text. Distinguish a product defect from an integration or configuration issue. If a minimal reproduction still fails against documented behaviour, that is a support case: https://support.syncfusion.com/ ## 9. Next | Need | Go to | | --- | --- | | Full documentation | https://help.syncfusion.com/maui/common/migration | | Every skill in this pack | https://ai.syncfusion.com/xamarin-to-maui-migration/inventory.txt | | Skill catalog across all 18 packs | https://ai.syncfusion.com/skills/catalog.md | | Licensing and trust boundaries | https://ai.syncfusion.com/licensing.md | | MCP configuration | https://ai.syncfusion.com/mcp/llms.txt | | Project scaffolding from the CLI | https://ai.syncfusion.com/cli.md | | Another platform | https://ai.syncfusion.com/llms.txt | | Support | https://support.syncfusion.com/ | ============================================================================== # LICENSING AND TRUST BOUNDARIES, INLINED ============================================================================== # Syncfusion licensing and agent trust boundaries Source: https://ai.syncfusion.com/licensing.md Canonical: https://ai.syncfusion.com/licensing.md Essential-Studio-release: 2026 Volume 2 (v34.1.29) Applies-to: all Syncfusion platforms and SDKs Audience: AI coding agents, and the humans reviewing what an agent did License-posture: This document defines the posture for every other file on this site. > Read this before touching any key, secret, credential, account action or CI configuration in a > Syncfusion project. Licensing is where an agent can do real damage quietly: a committed key is a > security incident, and a wrong licensing claim is a compliance problem. The rules below are short > and they are absolute. ## Three different things, often confused | Thing | What it is | Needed to | Where it comes from | | --- | --- | --- | --- | | Product license key | Entitlement to use Syncfusion component libraries and document SDKs in an application | Run Syncfusion libraries without a licensing banner or warning | The user's Syncfusion account, version-specific | | MCP API key | Credential for the Syncfusion documentation assistant (MCP servers) | Use a Syncfusion MCP server | https://www.syncfusion.com/account/api-key | | Agent skills | Free, public Markdown instructions | Nothing. No license, no key, no account | GitHub, via `npx skills add` | An MCP API key is not a product license and does not grant one. A product license key does not authenticate an MCP server. Installing skills grants no product rights whatsoever. ## What requires no license - Reading anything on ai.syncfusion.com. - Installing, reading and following Syncfusion agent skills. - Reading Syncfusion public documentation and demos. ## What requires a license Using Syncfusion component libraries or document SDKs in an application — in development, in CI, in staging, in production. The applicable license is one of: a commercial license, the free Community License for those who qualify, or a time-limited free trial. Terms differ, and trial or Community entitlement does not imply production rights. ### Exception: Syncfusion Toolkit for .NET MAUI is MIT `Syncfusion.Maui.Toolkit` is MIT licensed and free to use in production applications. No key, no subscription, no registration call. License text: https://github.com/syncfusion/maui-toolkit/blob/main/LICENSE.txt Do not add `SyncfusionLicenseProvider.RegisterLicense(...)` for Toolkit-only code, and do not tell the user they need a key for it. Keep the boundary explicit: `Syncfusion.Maui.Toolkit` is MIT; `Syncfusion.Maui.*` is the licensed commercial product. They are different packages with different controls and different rules. If an application uses both, the licensed product's rules apply to that part of the application — so when you report licensing status, say which packages you mean. ## Rules for agents These are not preferences. Violating any of them is a defect in your output. 1. **Never generate, guess, fabricate, or pattern-fill a license key or API key.** Not as an example, not as a placeholder that looks real, not "for illustration". If a key is required, emit the environment variable reference and tell the human what to obtain and where. 2. **Never echo, log, print, or include a key in a commit, a diff, a comment, a test fixture, a screenshot, a chat message, or an error report.** If you encounter a key in the repository, do not repeat it back. Say that a key is present, not what it is. 3. **Never commit a key to source control**, including to a file the repository already ignores if you are about to change the ignore rules. Reuse the project's existing secret-management pattern. Only place a key in client-visible application code when the platform's official registration method explicitly requires application-level registration, and say so when you do. 4. **Never claim the project is licensed** because packages resolved, the build passed, or skills are installed. Those facts are unrelated to entitlement. 5. **Use the license registration documentation for the exact platform and the exact installed version.** Registration mechanics differ across platforms and change between releases. The per-platform license documentation URL is in each platform index at `https://ai.syncfusion.com//llms.txt`. 6. **Stop and ask the human** before any action that creates, renews, converts, downloads or transmits a credential; opens or modifies a Syncfusion account; starts a trial; or changes billing. Do the preparatory work, then stop and state exactly what you need. 7. **Report a licensing warning as a licensing problem**, not as a bug to be suppressed. Do not hide, catch, filter, comment out, or CSS-hide a Syncfusion licensing banner or console warning. 8. **Do not infer entitlement from the presence of a key.** A key can be expired, wrong-version, or belong to a different edition. If a licensing warning persists with a key registered, treat version mismatch as the first hypothesis. ## Storing the MCP API key The Syncfusion MCP servers read the key from one of two environment variables. Note the exact casing — it is not `SYNCFUSION_API_KEY`. | Variable | Value | Use | | --- | --- | --- | | `Syncfusion_API_Key_Path` | Absolute path to a `.txt` or `.key` file containing the key | Recommended. Keeps the key out of committed config files | | `Syncfusion_API_Key` | The key itself, inline | Only where a path is not usable | Prefer `Syncfusion_API_Key_Path` and put the key file outside the repository, or inside it only if already covered by `.gitignore`. When you configure MCP for a user, write the variable, never the value, into any file that could be committed. ## CI and deployment - Read the product license key from the CI provider's secret store, injected as an environment variable at build time. Never from a checked-in file. - The key is version-specific. When a Syncfusion package version changes, the key may need to be regenerated; a licensing failure that appears immediately after an upgrade is almost always this. - Do not add a key to a container image layer, a build log, or a public artifact. - If a build needs a key that is not present, fail loudly with an actionable message. Do not stub, mock, or bypass license registration to make CI green. ## Where to send the human | They need | Send them to | | --- | --- | | An MCP API key | https://www.syncfusion.com/account/api-key | | A product license key, or to check entitlement | https://www.syncfusion.com/account/claim-license-key | | To understand license types and pricing | https://www.syncfusion.com/sales/pricing | | Community License eligibility | https://www.syncfusion.com/products/communitylicense | | Platform-specific registration steps | The `License-registration` line in that platform's index at https://ai.syncfusion.com//llms.txt | | A licensing question you cannot resolve | https://support.syncfusion.com/ | ## Ownership boundary — state this to the user A Syncfusion component is a licensed package installed from npm or NuGet. It is not source code the user vendors into their repository and owns. What the user owns and edits freely: the wrapper component, the configuration object, the data adapter, the theme tokens, the layout around the control, the event handlers. What the license governs: the Syncfusion package itself. Say this plainly if a user asks to "copy the component in" or compares Syncfusion to a copy-paste component distribution model. Setting the wrong expectation here produces a failure at first install, which is worse than setting no expectation at all.