Syncfusion AI Assistant

How can I help you?

Syncfusion Document SDK Agent Skills for AI Assistants

2 Apr 20268 minutes to read

This guide introduces Syncfusion Document SDK Skills, a knowledge package that enables AI assistants (GitHub Copilot, Code Studio, Cursor, Claude, etc.) to understand and generate accurate document processing code using Syncfusion® Document SDK libraries. It also supports executing document operations directly via CSX scripts.

Syncfusion® Document SDK Skills eliminate common issues with generic AI suggestions by grounding the assistant in accurate Syncfusion® Document SDK library APIs, document processing patterns, and platform-specific configuration for the following libraries:

Document Processing Libraries Skills
Word (DocIO) syncfusion-dotnet-word
syncfusion-java-word
PDF syncfusion-dotnet-pdf
syncfusion-dotnet-pdf-to-image
syncfusion-flutter-pdf
syncfusion-javascript-pdf
Excel (XlsIO) syncfusion-dotnet-excel
syncfusion-flutter-excel
PowerPoint (Presentation) syncfusion-dotnet-powerpoint
Markdown syncfusion-dotnet-markdown
Smart Data Extraction syncfusion-dotnet-smart-data-extraction
Calculate syncfusion-dotnet-calculate

Prerequisites

Before installing Syncfusion® Document SDK Skills, ensure the following tools are available on your machine:

  • Node.js (v18 or later) — Required to run npx commands for installing skills.
  • .NET SDK (8.0 or later) — Required for CSX script execution (Mode 2).
  • dotnet-script — Required for CSX script execution (Mode 2). Install it globally by running: dotnet tool install -g dotnet-script.
  • A supported AI agent or IDE that integrates with the Skills CLI (VS Code, Syncfusion® Code Studio, Cursor, etc.)

Installation

Use one of the following commands to install Syncfusion® Document SDK Skills based on your preference. You can also explore Syncfusion® skills from the marketplace.

To install all document SDK skills at once, use the following command:

npx skills add syncfusion/document-sdk-skills -y

To install a specific skill, use the following command (for example, to install PDF .NET skills):

npx skills add syncfusion/document-sdk-skills --skill syncfusion-dotnet-pdf

Choose and install skills interactively from the terminal:

npx skills add syncfusion/document-sdk-skills

The terminal will show a list of available skills. Use the arrow keys to navigate, space bar to select the skills you want, and Enter to confirm.

Select skills to install (space to toggle)
│  ◻ syncfusion-dotnet-pdf
│  ◻ syncfusion-dotnet-word
│  ◻ syncfusion-dotnet-excel
│  ◻ syncfusion-dotnet-powerpoint
│  ◻ syncfusion-dotnet-markdown
│  ◻ syncfusion-dotnet-smart-data-extraction
│  ◻ syncfusion-dotnet-calculate
│  ◻ syncfusion-java-word
│  ◻ syncfusion-flutter-pdf
│  ◻ syncfusion-javascript-pdf
│  .....

Next, select which AI agent you’re using and where to store the skills.

│  ── Additional agents ─────────────────────────────
│  Search:  
│  ↑↓ move, space select, enter confirm
│
│ ❯ ○ Augment (.augment/skills)
│   ○ Claude Code (.claude/skills)
│   ○ OpenClaw (skills)
│   ○ CodeBuddy (.codebuddy/skills)
│   ○ Command Code (.commandcode/skills)
│   ○ Continue (.continue/skills)
│   ○ Cortex Code (.cortex/skills)
│   ○ Crush (.crush/skills)
|   ....

Choose your installation scope (project-level or global), then confirm to complete the installation.

◆  Installation scope
│  ● Project (Install in current directory (committed with your project))
│  ○ Global

◆  Proceed with installation?
│  ● Yes / ○ No

This registers the Syncfusion® skill pack so your AI assistant can automatically load it in supported IDEs such as Code Studio, Visual Studio Code, and Cursor.

To learn more about the Skills CLI, refer here.

How Syncfusion® Document SDK Agent Skills Work

  1. Read the relevant skill files and choose modes based on the user’s query The assistant retrieves library APIs, and code patterns from the installed Syncfusion® Skills. It automatically chooses the appropriate operating mode based on the provided prompt.

  2. Operates in two modes based on the user’s intent:

    • Mode 1 — Generate Code:

      • Triggered when the prompt includes keywords such as "code", "snippet", "how to", "show me", "sample", or "example".
      • Detects the application type and recommends the required NuGet packages.
      • Generates production-ready code by referencing the appropriate references/*.md files for the requested functionalities.

    • Mode 2 — Execute via CSX Script:

      • Triggered when the prompt includes keywords such as "create", "generate", "make", "open", "edit", "modify", or when a file path is provided (e.g., output/report.docx).
      • Creates a temporary .csx script by inserting the appropriate code snippet from the relevant references/*.md files.
      • Executes the script using dotnet script and generates the output document.
      • Performs cleanup by deleting the temporary .csx script.
  3. Register licensing key Configuring the Syncfusion® license key from SyncfusionLicense.txt file at workspace root folder or the SYNCFUSION_LICENSE_KEY environment variable.

Using the AI Assistant

Once skills are installed, the assistant can generate Syncfusion® document processing code or execute document generation tasks. Below are example prompts for each mode.

Generate Code (Mode 1):

  • “How do I add a digital signature to a PDF?”
  • “Give me a code snippet to create an Excel workbook with a pivot table using XlsIO.”
  • “Show me DocIO code to create a Word document with a title and a paragraph.”
  • “Generate a C# snippet to add a table to a PowerPoint slide.”
  • “Show me code to extract all fields and tables from a PDF as JSON using Smart Data Extraction.”
  • “Show me how to parse and compute formulas using CalcQuickBase”

Execute Task (Mode 2):

  • “Create a PDF report with a title page and inventory table, save to output/report.pdf.”
  • “Create a sales summary workbook and save it to output/sales.xlsx.”
  • “Create a Word document about the top 5 programming languages in 2025.”
  • “Create a 5-slide meeting agenda presentation and save it to output/agenda.pptx.”
  • “Extract data from the PDF at Input/invoice.pdf using Smart Data Extraction and save to output/data.json.”

Skills CLI Commands

After installation, manage Syncfusion® Agent Skills using the following commands:

List Skills

View all installed skills in your current project or global environment:

npx skills list

Note: If you installed Syncfusion skills globally, add the --global flag at the end of the command (for example, npx skills list --global, npx skills remove <skill-name> --global ).

Remove a Skill

Uninstall a specific skill from your environment:

npx skills remove <skill-name>

Replace <skill-name> with the name of the skill you want to remove (for example, syncfusion-dotnet-pdf).

Check for Updates

Check if updates are available for your installed skills:

npx skills check

Update All Skills

Update all installed skills to their latest versions:

npx skills update

FAQ

Which agents and IDEs are supported?

Any Skills compatible agent or IDE that loads local skill files (Visual Studio Code, Cursor, CodeStudio, etc.).

Are skills loaded automatically?

Yes. Once installed, supported agents automatically detect and load relevant skills for Syncfusion‑related queries without requiring additional configuration.

Skills are not being loaded

Verify that skills are installed in the correct agent directory, restart the IDE, and confirm that the agent supports external skill files.

See also