|
| 1 | +--- |
| 2 | +title: Syncfusion Document SDK Agent Skills for AI Assistants | Syncfusion |
| 3 | +description: Learn how to install and use Syncfusion Document SDK Agent Skills to help AI assistants generate accurate document processing code with Document SDK libraries |
| 4 | +platform: document-processing |
| 5 | +control: Document SDK |
| 6 | +documentation: ug |
| 7 | +keywords: Skills, AI Assistants, Document SDK, Agent Skills |
| 8 | +--- |
| 9 | + |
| 10 | +# Syncfusion Document SDK Agent Skills for AI Assistants |
| 11 | + |
| 12 | +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<sup style="font-size:70%">®</sup> Document SDK libraries. It also supports executing document operations directly via CSX scripts. |
| 13 | + |
| 14 | +Syncfusion<sup style="font-size:70%">®</sup> Document SDK Skills eliminate common issues with generic AI suggestions by grounding the assistant in accurate Syncfusion<sup style="font-size:70%">®</sup> Document SDK library APIs, document processing patterns, and platform-specific configuration for the following libraries: |
| 15 | + |
| 16 | +| Document Processing Libraries | Skills | |
| 17 | +|---|---| |
| 18 | +| [Word (DocIO)](https://help.syncfusion.com/document-processing/word/overview) | syncfusion-dotnet-word <br> syncfusion-java-word | |
| 19 | +| [PDF](https://help.syncfusion.com/document-processing/pdf/overview) | syncfusion-dotnet-pdf <br> syncfusion-dotnet-pdf-to-image <br> syncfusion-flutter-pdf <br> syncfusion-javascript-pdf | |
| 20 | +| [Excel (XlsIO)](https://help.syncfusion.com/document-processing/excel/overview) | syncfusion-dotnet-excel <br> syncfusion-flutter-excel | |
| 21 | +| [PowerPoint (Presentation)](https://help.syncfusion.com/document-processing/powerpoint/overview) | syncfusion-dotnet-powerpoint | |
| 22 | +| [Markdown](https://help.syncfusion.com/document-processing/word/word-library/net/convert-markdown-to-word-document-in-csharp) | syncfusion-dotnet-markdown | |
| 23 | +| [Smart Data Extraction](https://help.syncfusion.com/document-processing/data-extraction/overview) | syncfusion-dotnet-smart-data-extraction | |
| 24 | + |
| 25 | +## Prerequisites |
| 26 | + |
| 27 | +Before installing Syncfusion<sup style="font-size:70%">®</sup> Document SDK Skills, ensure the following tools are available on your machine: |
| 28 | + |
| 29 | +- **[Node.js](https://nodejs.org/en)** (v18 or later) — Required to run `npx` commands for installing skills. |
| 30 | +- **[.NET SDK](https://dotnet.microsoft.com/en-us/download)** (8.0 or later) — Required for CSX script execution (Mode 2). |
| 31 | +- **[dotnet-script](https://github.com/dotnet-script/dotnet-script)** — Required for CSX script execution (Mode 2). Install it globally by running: `dotnet tool install -g dotnet-script`. |
| 32 | + |
| 33 | +## Installation |
| 34 | + |
| 35 | +Choose one of the following commands to install Syncfusion<sup style="font-size:70%">®</sup> Document SDK Skills based on your preference. You can also explore Syncfusion<sup style="font-size:70%">®</sup> skills from the [marketplace](https://skills.sh/syncfusion/). |
| 36 | + |
| 37 | +To install all document SDK skills at once, use the following command: |
| 38 | + |
| 39 | +```bash |
| 40 | +npx skills add syncfusion/document-sdk-skills --all -y |
| 41 | +``` |
| 42 | + |
| 43 | +To install a specific skill, use the following command (for example, to install PDF .NET skills): |
| 44 | + |
| 45 | +```bash |
| 46 | +npx skills add syncfusion/document-sdk-skills --skill syncfusion-dotnet-pdf |
| 47 | +``` |
| 48 | + |
| 49 | +This registers the Syncfusion<sup style="font-size:70%">®</sup> skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills). |
| 50 | + |
| 51 | +To learn more about the Skills CLI, refer [here](https://skills.sh/docs). |
| 52 | + |
| 53 | +## What's Included |
| 54 | + |
| 55 | +1. **Document SDK API Knowledge** — Curated, skill-based guidance for creating, editing, and converting PDF, Word, Excel, PowerPoint, and Markdown documents using Syncfusion<sup style="font-size:70%">®</sup> Document SDK libraries. Covers key APIs, supported formats, and conversions. |
| 56 | +2. **Dual-Mode Execution (.NET)** — Supports two operating modes: |
| 57 | + - **Mode 1** — Generate production-ready code for your project. |
| 58 | + - **Mode 2** — Execute a document task immediately via a CSX script without modifying your project. |
| 59 | +3. **Patterns & Best Practices** — Practical recommendations for API usage, platform-specific NuGet package selection, and document processing workflows (for example, mail merge, PDF digital signatures, Excel pivot tables, and PowerPoint chart creation). All guidance is authored directly within the skill file rather than being fetched from external documentation. |
| 60 | + |
| 61 | + |
| 62 | +## How Syncfusion<sup style="font-size:70%">®</sup> Document SDK Agent Skills Work |
| 63 | + |
| 64 | +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<sup style="font-size:70%">®</sup> Skills. It automatically chooses the appropriate operating mode based on the provided prompt. |
| 65 | +2. **Enforces Syncfusion<sup style="font-size:70%">®</sup> best practices**, including: |
| 66 | + - Suggesting the correct NuGet packages or JAR files based on the detected application type. |
| 67 | + - Using only APIs and code patterns explicitly present in the skill reference files. |
| 68 | + - Configuring the Syncfusion<sup style="font-size:70%">®</sup> license key from `SyncfusionLicense.txt` or the `SYNCFUSION_LICENSE_KEY` environment variable. |
| 69 | +3. **Operates in two modes** based on the user's intent: |
| 70 | + - **Mode 1 — Generate Code**: Produces production-ready code. No scripts are created or executed. Triggered by keywords such as `"code"`, `"snippet"`, `"how to"`, `"show me"`, `"sample"`, or `"example"`. |
| 71 | + - **Mode 2 — Execute via CSX Script**: Creates a temporary `.csx` script, runs it with `dotnet script`, produces the output document file, then cleans up — without modifying the user's project. Triggered by keywords such as `"create"`, `"generate"`, `"make"`, `"open"`, `"edit"`, `"modify"`, or a file path (e.g., `output/report.docx`). |
| 72 | + |
| 73 | +## Using the AI Assistant |
| 74 | + |
| 75 | +Once skills are installed, the assistant can generate Syncfusion<sup style="font-size:70%">®</sup> document processing code or execute document generation tasks. Below are example prompts for each mode. |
| 76 | + |
| 77 | +**Generate Code (Mode 1):** |
| 78 | + |
| 79 | +- "How do I add a digital signature to a PDF?" |
| 80 | +- "Give me a code snippet to create an Excel workbook with a pivot table using XlsIO." |
| 81 | +- "Show me DocIO code to create a Word document with a title and a paragraph." |
| 82 | +- "Generate a C# snippet to add a table to a PowerPoint slide." |
| 83 | +- "Show me code to extract all fields and tables from a PDF as JSON using Smart Data Extraction." |
| 84 | + |
| 85 | +**Execute Task (Mode 2):** |
| 86 | + |
| 87 | +- "Create a PDF report with a title page and inventory table, save to output/report.pdf." |
| 88 | +- "Create a sales summary workbook and save it to output/sales.xlsx." |
| 89 | +- "Create a Word document about the top 5 programming languages in 2025." |
| 90 | +- "Create a 5-slide meeting agenda presentation and save it to output/agenda.pptx." |
| 91 | +- "Extract data from the PDF at Input/invoice.pdf using Smart Data Extraction and save to output/data.json." |
| 92 | + |
| 93 | +## See also |
| 94 | + |
| 95 | +- [Syncfusion Document SDK Documentation](https://help.syncfusion.com/document-processing/introduction) |
| 96 | +- [Agent Skills Standards](https://agentskills.io/home) |
| 97 | +- [Skills CLI](https://skills.sh/docs) |
| 98 | + |
0 commit comments