# 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 <name>`, 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 (
    <DocumentEditorContainerComponent
      id="container"
      height="640px"
      enableToolbar={true}
      // Server endpoint is required for .docx import/export and spell check.
      // Point at your own hosted Syncfusion Word Processor service.
      serviceUrl={import.meta.env.VITE_DOCUMENTEDITOR_SERVICE_URL}
    />
  );
}
```

## 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 | Use the inventory for your host platform, e.g. React https://ai.syncfusion.com/react/inventory.txt, Angular https://ai.syncfusion.com/angular/inventory.txt, ASP.NET Core https://ai.syncfusion.com/aspnet-core/inventory.txt, Blazor https://ai.syncfusion.com/blazor/inventory.txt, WPF https://ai.syncfusion.com/wpf/inventory.txt, UWP https://ai.syncfusion.com/uwp/inventory.txt, JavaScript https://ai.syncfusion.com/javascript/inventory.txt, Vue https://ai.syncfusion.com/vue/inventory.txt, ASP.NET MVC https://ai.syncfusion.com/aspnet-mvc/inventory.txt |
| 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/ |