SyncfusionDocumentSDKAssistant MCP Server

29 Jun 20268 minutes to read

Overview

The SyncfusionDocumentSDKAssistant is a specialized Model Context Protocol (MCP) server that provides intelligent assistance for developers using Syncfusion’s DocumentSDK libraries. This tool seamlessly integrates with compatible MCP clients to enhance your development workflow when building .NET applications with Syncfusion® Document Processing libraries, such as PDF, Word, Excel, and PowerPoint.

Key Benefits

  • Intelligent code generation for Syncfusion® DocumentSDK components.
  • Detailed component documentation and usage examples.
  • Troubleshooting assistance for common integration challenges.

Prerequisites

Before using SyncfusionDocumentSDKAssistant, ensure you have:

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.

API Key Configuration

Login to your Syncfusion account and generate an API Key from the API Key page. Replace YOUR_API_KEY_FILE_PATH or YOUR_API_KEY in the configuration files with your generated key.

There are two options:

  • Using an API Key File (Recommended)

    Store your API key in a separate file and reference its path in the Syncfusion_API_Key_Path environment parameter. This approach is more secure as you don’t expose the key directly in configuration files.

    Supported file formats: .txt or .key file

   "env": {
     "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // "D:\\syncfusion-key.txt" (or) "D:\\syncfusion-key.key"
    }

  • Direct API Key

    Paste your Syncfusion_API_Key directly in the configuration file’s environment parameter.

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

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

Setting up in MCP Clients

Create a configuration file in your project folder to install the server for your workspace as shown below:

Important: Replace YOUR_API_KEY_FILE_PATH with the path to your API key file.

// Create a `.vscode/mcp.json` file in your workspace with the MCP server configuration:

{
  "servers": {
   "syncfusion-documentsdk-assistant": {   
    "type": "stdio",
    "command": "npx",
    "args": [
     "-y",
     "@syncfusion/documentsdk-assistant@latest" 
    ],
    "env": {
     "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
      // or
     "Syncfusion_API_Key": "YOUR_API_KEY"
     }
    }
   }
  }
// Create a `.codestudio/mcp.json` file in your workspace with the MCP server configuration:

{
  "servers": {
   "syncfusion-documentsdk-assistant": {   
    "type": "stdio",
    "command": "npx",
    "args": [
     "-y",
     "@syncfusion/documentsdk-assistant@latest" 
    ],
    "env": {
     "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
      // or
     "Syncfusion_API_Key": "YOUR_API_KEY"
     }
    }
   }
  }
// Create a `.cursor/mcp.json` file in your workspace with the MCP server configuration:

{
   "mcpServers": {
    "syncfusion-documentsdk-assistant": {
     "type": "stdio",
     "command": "npx",
     "args": [
     "-y",
        "@syncfusion/documentsdk-assistant@latest"
      ],
      "env": {
      "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
      // or
      "Syncfusion_API_Key": "YOUR_API_KEY"
     }
    }
   }
  }
// 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_Path": "YOUR_API_KEY_FILE_PATH",
     // or
     "Syncfusion_API_Key": "YOUR_API_KEY"
     }
    }
   }
  }

Verify Installation: Check your editor’s MCP Server list for syncfusion-documentsdk-assistant with “Connected” status to confirm successful installation.

Usage

To activate the SyncfusionDocumentSDKAssistant MCP server:

  1. Start your prompt with one of the following:
    • ‘SyncfusionDocumentSDKAssistant’
    • ‘/syncfusion-document-assistant’
    • ‘/syncfusion-documentsdk’
    • ‘@syncfusion-documentsdk’
    • ‘@ask_syncfusion_documentsdk’

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

  2. Grant the SyncfusionDocumentSDKAssistant MCP server a permission to run for this session, workspace, or always.
  3. 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

  1. Be specific: Mention both platform and component (e.g., “How to digitally sign a PDF document using Syncfusion PDF library in .NET Core app?”).
  2. Provide context: Include details about your use case for more targeted solutions.
  3. Use descriptive queries: Avoid vague questions that lack necessary context.
  4. 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 during installation or while using the MCP server, refer to the solutions below:

Issue Solution
Clear npm cache Run npx clear-npx-cache and restart your IDE to resolve package caching issues
Server failed to start Update to Node.js 18+, verify JSON syntax in config file, and restart your IDE
Invalid API key Verify your key is active at Syncfusion Account Page
Incorrect API key config For the file path: Verify file location and content. For inline key: Check key is properly updated
Wrong config file location VS Code: .vscode/mcp.json
Code Studio: .codestudio/mcp.json
Cursor: .cursor/mcp.json
JetBrains: Settings → Tools → AI Assistant → MCP in the workspace root
Check IDE logs VS Code/Code Studio: Output panel → “MCP” • Cursor: Developer Console for MCP errors • JetBrains: IDE logs

Support

Product support is available through the following mediums.

See also