@syncfusion/documentsdk-assistant

SyncfusionDocumentSDKAssistant MCP Server

Overview

The SyncfusionDocumentSDKAssistant is a specialized Model Context Protocol (MCP) server designed to enhance development with Syncfusion's Document Processing Libraries, such as PDF, Word, Excel, and PowerPoint. It integrates seamlessly with MCP-compatible clients to provide intelligent assistance for building applications with Syncfusion^® components.

Key Features

• Intelligent code generation for Syncfusion^® Document Processing Libraries, such as PDF, Word, Excel, and PowerPoint.
• Detailed component documentation and usage examples.
• Troubleshooting assistance for common integration challenges.

Prerequisites

Before using SyncfusionDocumentSDKAssistant, ensure you have:

• Required node version >= 18
• A compatible MCP client (VS Code with GitHub Copilot, Syncfusion^® CodeStudio, etc.)
• An active Syncfusion^® license (any of the following):
  • Commercial License
  • Free Community License
  • Free Trial
• An active API KEY

Unlimited Access

Syncfusion^® offers unlimited access to this MCP server. There are no restrictions on:

• Number of requests
• Components usage
• Query types
• Usage duration

This ensures users can fully leverage Syncfusion^® components to enhance their development experience without limitations.

Installation

Before you can invoke the SyncfusionDocumentSDKAssistant MCP server, you need to configure your MCP client with these core settings. The Generic MCP Server Settings shown below are identical across all clients:

Generic MCP Server Settings

• npm package name: @syncfusion/documentsdk-assistant
• Type: stdio (standard input/output transport)
• Command: npx
• Arguments: -y
• Server name: syncfusionDocumentSDKAssistant

You need to add your Syncfusion API key as an env parameter in the configuration file:

"env": {
  "Syncfusion_API_Key": "YOUR_API_KEY"
}

SyncfusionDocumentSDKAssistant can be configured in various MCP clients. Below are setup instructions for popular environment:

Syncfusion^® Code Studio

• In Code Studio, open MCP Marketplace, find SyncfusionDocumentSDKAssistant, and click Install.
• When prompted, enter your Syncfusion API key and click Submit to register.
• It installs locally on your machine and appears in the Installed list.
• The server is now ready for use in Code Studio. For more details, refer to the Code Studio documentation.

VS Code (GitHub Copilot MCP)

• To configure an MCP server for a specific workspace, you can create a .vscode/mcp.json file in your workspace folder.

{
  "servers": {
    "syncfusion-documentsdk-assistant": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@syncfusion/documentsdk-assistant@latest"
      ],
      "env": {
        "Syncfusion_API_Key": "YOUR_API_KEY"
      }
    }
  }
}

• After updating the configuration in settings.json, you'll notice a "Start" option at the top of the config. This allows you to easily start the SyncfusionDocumentSDKAssistant server directly from the settings interface without additional commands.

• Confirm that SyncfusionDocumentSDKAssistant is being used (this does not happen automatically). Look for a statement in the output, which is similar to:

  • SyncfusionDocumentSDKAssistant is running... (in VS Code)

Cursor

To configure an MCP server for a specific workspace, you can create a .cursor/mcp.json file in your workspace folder.

{
  "mcpServers": {
    "syncfusion-documentsdk-assistant": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@syncfusion/documentsdk-assistant@latest"
      ],
      "env": {
       "Syncfusion_API_Key": "YOUR_API_KEY"
      }
    }
  }
}

JetBrains IDEs

• Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP).
• Click + Add to add a new MCP server configuration.
• In the New MCP Server dialog, switch the dropdown as As JSON and add the following config:

{
  "mcpServers": {
    "syncfusion-documentsdk-assistant": {
      "command": "npx",
      "args": [
        "-y",
        "@syncfusion/documentsdk-assistant@latest"
      ],
      "env": {
       "Syncfusion_API_Key": "YOUR_API_KEY"
      }
    }
  }
}

• Click OK and Apply.

For additional configuration details, refer to:

• VS Code
• Cursor
• JetBrains
• Windsurf

Usage

To activate the SyncfusionDocumentSDKAssistant MCP server:

• Start your prompt with one of the following:

  • 'SyncfusionDocumentSDKAssistant'
  • '/syncfusion-documentsdk-assistant'
  • '/syncfusion-documentsdk'
  • '@syncfusion-documentsdk'
  • '@ask_syncfusion_documentsdk'

  In VS Code, you can also use #SyncfusionDocumentSDKAssistant to explicitly invoke the MCP server.

• Grant the SyncfusionDocumentSDKAssistant MCP server a permission to run for this session, workspace, or always.

• For best results, start a new chat for each new topic to maintain clean context.

Mode availability

Syncfusion^® MCP Servers provide full access to all AI interaction modes — Ask/Chat, Edit, and Agent — across supported MCP clients.

Best Practices for Effective Usage

• Be specific: Mention both platform and component (e.g., "How to digitally sign a PDF document using Syncfusion PDF library in .NET Core app?").
• Provide context: Include details about your use case for more targeted solutions.
• Use descriptive queries: Avoid vague questions that lack necessary context.
• Start fresh for new topics: Begin a new chat session when switching components or topics.

Example Queries

Here are some effective ways to use SyncfusionDocumentSDKAssistant:

• "Create an Excel file with formulas, charts, and conditional formatting using Syncfusion in WPF."
• "How to perform a mail merge in a Word document using Syncfusion Word library?"
• "Extract text and images from an existing PDF using Syncfusion."
• "How do I convert a Word document to PDF using Syncfusion in Blazor app?"
• "Using Syncfusion, how can I combine multiple PowerPoint presentations into one in a WinUI application?"

Troubleshooting

If you encounter issues:

• Verify your API key is correctly configured.
• Ensure the MCP server is enabled in your client's tools selection.
• Check that you're using a compatible MCP client version.
• Try restarting your development environment.

Support

Product support is available through the following mediums.

• Support ticket - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
• Community forum
• Request feature or report bug
• Live chat

License

This is a commercial product and requires a paid license for possession or use. Syncfusion^® licensed software, including this component, is subject to the terms and conditions of Syncfusion's EULA. To acquire a license, you can purchase here or start a free 30-day trial here. A free community license is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers. © Copyright 2025 Syncfusion^® Inc. All Rights Reserved. The Syncfusion^® Essential Studio^® license and copyright applies to this distribution. The Syncfusion^® Essential^® Studio license and copyright applies to this distribution.