|
| 1 | +--- |
| 2 | +layout: post |
| 3 | +title: SyncfusionDocumentSDKAssistant MCP Server Setup – Syncfusion |
| 4 | +description: Explore the MCP server’s benefits, setup needs, and integration guidance for Syncfusion DocumentSDK. |
| 5 | +platform: document-processing |
| 6 | +control: AI coding assistant |
| 7 | +documentation: ug |
| 8 | +--- |
| 9 | + |
| 10 | +# SyncfusionDocumentSDKAssistant MCP Server |
| 11 | + |
| 12 | + |
| 13 | +## Overview |
| 14 | + |
| 15 | +The SyncfusionDocumentSDKAssistant a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides intelligent assistance for developers using Syncfusion’s DocumentSDK libraries. This tool seamlessly integrates with compatible [MCP clients](https://modelcontextprotocol.io/clients) to enhance your development workflow when building .NET applications with Syncfusion<sup>®</sup> Document Processing libraries, such as PDF, Word, Excel, and PowerPoint. |
| 16 | + |
| 17 | +### Key Benefits |
| 18 | + |
| 19 | + * Intelligent code generation for Syncfusion<sup>®</sup> DocumentSDK components. |
| 20 | + * Detailed component documentation and usage examples. |
| 21 | + * Troubleshooting assistance for common integration challenges. |
| 22 | + |
| 23 | +## Prerequisites |
| 24 | + |
| 25 | +Before using <a href="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant</a>, ensure you have: |
| 26 | + |
| 27 | + * Required [node](https://nodejs.org/en/) version >= 18 |
| 28 | + * A [compatible MCP client](https://modelcontextprotocol.io/clients) (VS Code with GitHub Copilot, [Syncfusion<sup>®</sup> CodeStudio](https://www.syncfusion.com/code-studio/), etc.) |
| 29 | + * An active Syncfusion<sup>®</sup> license (any of the following): |
| 30 | + * [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense) |
| 31 | + * [Free Community License](https://www.syncfusion.com/products/communitylicense) |
| 32 | + * [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials) |
| 33 | + * An active [API KEY](https://syncfusion.com/account/api-key) |
| 34 | + |
| 35 | +## Unlimited Access |
| 36 | + |
| 37 | +Syncfusion<sup>®</sup> offers unlimited access to this MCP server. There are no restrictions on: |
| 38 | + |
| 39 | + * Number of requests |
| 40 | + * Components usage |
| 41 | + * Query types |
| 42 | + * Usage duration |
| 43 | + |
| 44 | +This ensures users can fully leverage Syncfusion<sup>®</sup> components to enhance their development experience without limitations. |
| 45 | + |
| 46 | +## Installation and setup |
| 47 | + |
| 48 | +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: |
| 49 | + |
| 50 | +### Generic MCP Server Settings |
| 51 | + |
| 52 | + * **npm package name**: ```@syncfusion/documentsdk-assistant``` |
| 53 | + * **Type**: stdio (standard input/output transport) |
| 54 | + * **Command**: npx |
| 55 | + * **Arguments**: -y |
| 56 | + * **Server name**: syncfusionDocumentSDKAssistant |
| 57 | + |
| 58 | +You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file: |
| 59 | + |
| 60 | +~~~ |
| 61 | + "env": { |
| 62 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 63 | + } |
| 64 | +~~~ |
| 65 | + |
| 66 | +<a href="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant</a> can be configured in various MCP clients. Below are setup instructions for popular environments: |
| 67 | + |
| 68 | +### Syncfusion<sup>®</sup> Code Studio |
| 69 | + |
| 70 | + * In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the ```Custom Servers``` tab. |
| 71 | + * Enter the Server Name as ```documentsdk-mcp```, choose Server Type as npm package, and set the NPM Package name to ```@syncfusion/documentsdk-assistant```. |
| 72 | + * Add an environment variable as ```Syncfusion_API_Key``` and value as your [Syncfusion API key](https://syncfusion.com/account/api-key), then click **Install Server**. |
| 73 | + * Once installed, the server will appear in the User Installed Server list and will be added to the **config.yaml** file. |
| 74 | + * The server is now ready for use in Code Studio. For more details, refer to the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers). |
| 75 | + |
| 76 | +For additional details, see the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers). |
| 77 | + |
| 78 | +### VS Code (GitHub Copilot MCP) |
| 79 | + 1. To configure an MCP server for a specific workspace, you can create a ```.vscode/mcp.json``` file in your workspace folder. |
| 80 | + |
| 81 | +~~~json |
| 82 | + { |
| 83 | + "servers": { |
| 84 | + "syncfusion-documentsdk-assistant": { |
| 85 | + "type": "stdio", |
| 86 | + "command": "npx", |
| 87 | + "args": [ |
| 88 | + "-y", |
| 89 | + "@syncfusion/documentsdk-assistant@latest" |
| 90 | + ], |
| 91 | + "env": { |
| 92 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 93 | + } |
| 94 | + } |
| 95 | + } |
| 96 | + } |
| 97 | +~~~ |
| 98 | + |
| 99 | + 2. 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 <a href ="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant</a> server directly from the settings interface without additional commands. |
| 100 | + |
| 101 | + 3. Confirm that <a href ="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant</a> is being used (this does not happen automatically). Look for a statement in the output, which is similar to: |
| 102 | + |
| 103 | + * ```SyncfusionDocumentSDKAssistant is running...``` (in VS Code) |
| 104 | + 4. For more details, refer to the official <a href = "https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022"> Visual Studio documentation </a>. |
| 105 | + |
| 106 | +### Cursor |
| 107 | + |
| 108 | +To configure an MCP server for a specific workspace, you can create a .cursor/mcp.json file in your workspace folder. |
| 109 | + |
| 110 | +~~~json |
| 111 | + { |
| 112 | + "mcpServers": { |
| 113 | + "syncfusion-documentsdk-assistant": { |
| 114 | + "type": "stdio", |
| 115 | + "command": "npx", |
| 116 | + "args": [ |
| 117 | + "-y", |
| 118 | + "@syncfusion/documentsdk-assistant@latest" |
| 119 | + ], |
| 120 | + "env": { |
| 121 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 122 | + } |
| 123 | + } |
| 124 | + } |
| 125 | + } |
| 126 | +~~~ |
| 127 | +For more details, refer to the <a href = "https://docs.cursor.com/en/context/mcp#using-mcp-json">Cursor documentation</a>. |
| 128 | + |
| 129 | +### JetBrains IDEs |
| 130 | + |
| 131 | + 1. Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP). |
| 132 | + 2. Click + Add to add a new MCP server configuration. |
| 133 | + 3. In the New MCP Server dialog, switch the dropdown as ```As JSON``` and add the following config: |
| 134 | + |
| 135 | +~~~json |
| 136 | + { |
| 137 | + "mcpServers": { |
| 138 | + "syncfusion-documentsdk-assistant": { |
| 139 | + "command": "npx", |
| 140 | + "args": [ |
| 141 | + "-y", |
| 142 | + "@syncfusion/documentsdk-assistant@latest" |
| 143 | + ], |
| 144 | + "env": { |
| 145 | + "Syncfusion_API_Key": "YOUR_API_KEY" |
| 146 | + } |
| 147 | + } |
| 148 | + } |
| 149 | + } |
| 150 | +~~~ |
| 151 | + |
| 152 | + 4. Click OK and Apply. |
| 153 | + |
| 154 | +For further assistance, see the <a href ="https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server">JetBrains documentation</a>. |
| 155 | + |
| 156 | +> For more detailed information about configuring MCP servers in various clients, refer to the official documentations, e.g., [Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json) |
| 157 | +
|
| 158 | +## Usage |
| 159 | + |
| 160 | +To activate the SyncfusionDocumentSDKAssistant MCP server: |
| 161 | + |
| 162 | + 1. Start your prompt with one of the following: |
| 163 | + * ‘SyncfusionDocumentSDKAssistant’ |
| 164 | + * ‘/syncfusion-document-assistant’ |
| 165 | + * ‘/syncfusion-documentsdk’ |
| 166 | + * ‘@syncfusion-documentsdk’ |
| 167 | + * ‘@ask_syncfusion_documentsdk’ |
| 168 | + In VS Code, you can also use #SyncfusionDocumentSDKAssistant to explicitly invoke the MCP server. |
| 169 | + 2. Grant the SyncfusionDocumentSDKAssistant MCP server a permission to run for this session, workspace, or always. |
| 170 | + 3. For best results, start a new chat for each new topic to maintain clean context. |
| 171 | + |
| 172 | +### Mode availability |
| 173 | + |
| 174 | +Syncfusion® MCP Servers provide full access to all AI interaction modes — Ask/Chat, Edit, and Agent — across supported MCP clients. |
| 175 | + |
| 176 | +### Best Practices for Effective Usage |
| 177 | + |
| 178 | + 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?"). |
| 179 | + 2. ```Provide context:``` Include details about your use case for more targeted solutions. |
| 180 | + 3. ```Use descriptive queries```: Avoid vague questions that lack necessary context. |
| 181 | + 4. ```Start fresh for new topics```: Begin a new chat session when switching components or topics |
| 182 | + |
| 183 | +### Example Queries |
| 184 | + |
| 185 | +Here are some effective ways to use SyncfusionDocumentSDKAssistant: |
| 186 | + |
| 187 | + * "Create an Excel file with formulas, charts, and conditional formatting using Syncfusion in WPF." |
| 188 | + * "How to perform a mail merge in a Word document using Syncfusion Word library?" |
| 189 | + * "Extract text and images from an existing PDF using Syncfusion." |
| 190 | + * "How do I convert a Word document to PDF using Syncfusion in Blazor app?" |
| 191 | + * "Using Syncfusion, how can I combine multiple PowerPoint presentations into one in a WinUI application?" |
| 192 | + |
| 193 | +## Troubleshooting |
| 194 | + |
| 195 | +If you encounter issues: |
| 196 | + |
| 197 | + * Verify your API key is correctly configured. |
| 198 | + * Ensure the MCP server is enabled in your client’s tools selection. |
| 199 | + * Check that you’re using a compatible MCP client version. |
| 200 | + * Try restarting your development environment. |
| 201 | + |
| 202 | +## Support |
| 203 | + |
| 204 | +Product support is available through the following mediums. |
| 205 | + |
| 206 | + * [Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support |
| 207 | + * [Community forum](https://www.syncfusion.com/forums/document-sdk) |
| 208 | + * [Request feature or report bug](https://www.syncfusion.com/feedback/document-sdk) |
| 209 | + * Live chat |
| 210 | + |
| 211 | +## See also |
| 212 | + |
| 213 | + * [Syncfusion DocumentSDK Documentation](https://help.syncfusion.com/document-processing/introduction) |
| 214 | + |
| 215 | + |
| 216 | + |
| 217 | + |
| 218 | + |
| 219 | + |
| 220 | + |
| 221 | + |
0 commit comments