diff --git a/Document-Processing/mcp.md b/Document-Processing/mcp.md new file mode 100644 index 0000000000..f5016bf10d --- /dev/null +++ b/Document-Processing/mcp.md @@ -0,0 +1,267 @@ +--- +layout: post +title: Syncfusion DocumentSDK MCP Server Setup – Syncfusion +description: Discover the MCP server’s advantages, installation requirements, and integration guidance for Syncfusion DocumentSDK. +platform: document-processing +control: AI coding assistant +documentation: ug +--- + +# Syncfusion Document SDK MCP Server + +Syncfusion® Document SDK MCP Server accelerates document processing application development by providing deep knowledge directly in your AI-powered IDE. [Model Context Protocol](https://modelcontextprotocol.io/docs/2026-07-28/getting-started/intro) (MCP) integration enables quick access to documentation, API references, and code-generation features from within the development environment. + +These tools speed up development and reinforce best practices for Syncfusion document processing libraries integration. + +## Key Benefits + +- **Expert Document Processing Knowledge** - Deep understanding of Syncfusion document processing libraries (PDF, Word, Excel, PowerPoint, Markdown) and their implementation patterns. +- **Unlimited Usage** - No request limits, time restrictions, or query caps. +- **Privacy-Focused** - The tools operate based on the user's query and do not store any content, data, or prompts. + +## Installation + +### Prerequisites + +Before beginning, ensure the following prerequisites are met: + +- Microsoft [.NET SDK 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) or later +- A **compatible MCP client** (VS Code, Syncfusion® Code Studio, Cursor, JetBrains, etc.) +- An active [Syncfusion® API key](https://syncfusion.com/account/api-key) +- A **document processing application** (existing or new); see [Syncfusion Document Processing documentation](https://help.syncfusion.com/document-processing/introduction) +- An active Syncfusion® license (any of the following): + - [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense) + - [Free Community License](https://www.syncfusion.com/products/communitylicense) + - [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials) + +### Getting Your API Key + +Generate the Syncfusion® API key from the [API Key page](https://www.syncfusion.com/account/api-key) and store it in a `.txt` or `.key` file. The saved file will be referenced in the MCP configuration: + +````json +"env": { + "Syncfusion_API_Key_Path": "D:\\syncfusion-key.txt" +} +```` + +> Alternatively, the API key can also be set directly using `"Syncfusion_API_Key": "YOUR_API_KEY"` in the env configuration. Using a file path is recommended to keep the key out of source control. + +### Setting Up in MCP Clients + +Create a configuration file in your project folder to install the server for your workspace. **Replace `YOUR_API_KEY_FILE_PATH` with the path to your API key file.** The tabs below show a working configuration for each supported MCP client. + +**For .NET 10** : + +{% tabs %} +{% highlight bash tabtitle="VS Code" %} + +// Create a `.vscode/mcp.json` file in your workspace: + +{ + "servers": { + "sf-documentsdk-mcp": { + "type": "stdio", + "command": "dnx", + "args": ["Syncfusion.DocumentSdk.MCP", "--yes"], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" + // or + // "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} + +{% endhighlight %} +{% highlight bash tabtitle="Code Studio" %} + +// Create a `.codestudio/mcp.json` file in your workspace: + +{ + "servers": { + "sf-documentsdk-mcp": { + "type": "stdio", + "command": "dnx", + "args": ["Syncfusion.DocumentSdk.MCP", "--yes"], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" + // or + // "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} + +// After creating the file, click Start in the inline action to install the server. + +{% endhighlight %} +{% highlight bash tabtitle="Cursor" %} + +// Create a `.cursor/mcp.json` file in your workspace: + +{ + "mcpServers": { + "sf-documentsdk-mcp": { + "command": "dnx", + "args": ["Syncfusion.DocumentSdk.MCP", "--yes"], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" + // or + // "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} + +{% endhighlight %} +{% highlight bash tabtitle="JetBrains" %} + +// Open AI Assistant chat, type /, and select Add Command. +// Click ➕ Add on the MCP settings page. +// Choose STDIO and select JSON configuration: + +{ + "mcpServers": { + "sf-documentsdk-mcp": { + "command": "dnx", + "args": ["Syncfusion.DocumentSdk.MCP", "--yes"], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" + // or + // "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } +} + +// Click OK, then click Apply. The server starts and shows Connected status. + +{% endhighlight %} +{% endtabs %} + +**For .NET 8 / .NET 9 (using a local tool):** + +You can install the Syncfusion Document SDK MCP server as a local tool without a global installation. For guidance on installing and managing local .NET tools, refer to the [documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use). + +1. Install the Syncfusion Document SDK MCP tool locally: + + ````bash + dotnet tool install Syncfusion.DocumentSdk.MCP + ```` + + > If the project does not already have a tool manifest, create one first by running `dotnet new tool-manifest` in the project root. This generates a shared `.config/dotnet-tools.json` file that tracks local tools, then re-run the install command above. + +2. In your MCP client config (for example, `.vscode/mcp.json`), replace the server entry with: + + ````json + { + "servers": { + "sf-documentsdk-mcp": { + "type": "stdio", + "command": "dotnet", + "args": ["tool", "run", "syncfusion-documentsdk-mcp"], + "env": { + "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" + // or + // "Syncfusion_API_Key": "YOUR_API_KEY" + } + } + } + } + ```` + +**Verifying Installation** Check your editor's MCP Server list for `sf-documentsdk-mcp` with a **Connected** status to confirm a successful installation. + +## Common use cases + +The examples below showcase how the `search_docs` tool handles real-world document processing development scenarios. The tool can be invoked directly, as shown in the examples below, for specific needs. Alternatively, an AI assistant can automatically invoke it based on the request. + +**Get Started** + +Use `search_docs` to get contextual guidance, code snippets, and configuration examples for any document processing library. + +{% promptcards %} +{% promptcard PDF Creation %} +#search_docs Create a PDF document with text, images, and tables using Syncfusion PDF library. +{% endpromptcard %} +{% endpromptcards %} + +{% promptcards %} +{% promptcard Word Document Processing %} +#search_docs How do I create and manipulate Word documents with Syncfusion Word library? +{% endpromptcard %} +{% endpromptcards %} + +**Implement Features** + +Get step-by-step help for adding specific features to document processing libraries. + +{% promptcards %} +{% promptcard PDF Conversion %} +#search_docs How can I convert Word documents to PDF using Syncfusion libraries? +{% endpromptcard %} +{% endpromptcards %} + +{% promptcards %} +{% promptcard Excel Data Processing %} +#search_docs How do I read, write, and format Excel files with Syncfusion XlsIO library? +{% endpromptcard %} +{% endpromptcards %} + +**Troubleshooting** + +Describe the problem in plain language, and let `search_docs` help resolve it. +{% promptcards %} +{% promptcard PDF Issues %} +#search_docs Why isn't my PDF rendering correctly or displaying images properly? +{% endpromptcard %} +{% endpromptcards %} + +{% promptcards %} +{% promptcard Word Document Issues %} +#search_docs Why is my Word document not converting or formatting correctly? +{% endpromptcard %} +{% endpromptcards %} + +## Best Practices + +To get the most out of the Syncfusion® Document SDK MCP Server: + +- **Be Specific** - Include the library and use case in your queries (for example, *"Create a PDF with tables and formatted text using Syncfusion PDF library"*). +- **Provide Context** - Include applicable versions, expected outcomes, and any requirements or limitations that may affect the request. +- **Use Descriptive Queries** - Avoid overly brief or ambiguous requests. Providing sufficient detail helps improve the accuracy and relevance of the response. +- **Stay Consistent** - Keep file organization, naming conventions, and coding standards consistent throughout your document processing project. +- **Start Fresh for New Topics** - Begin a new chat when switching to a different document library or task to maintain clean context. +- **Use Advanced AI Models** - For the best results, use advanced AI models such as the latest-generation **Claude**, **GPT**, or **Gemini** models. +- **For Troubleshooting** - Use AI suggestions for common issues; consult the [official documentation](https://help.syncfusion.com/document-processing/introduction) or [support](https://support.syncfusion.com/support/tickets/create) for complex problems. +- **Minimize Active Tools** - Limit the number of active MCP tools in your IDE to prevent tool-selection ambiguity and improve response accuracy. + +> Always review AI-generated code before using it in production. + +## Troubleshooting + +The table below lists frequently encountered issues and suggested resolutions to help diagnose and address common setup or usage challenges. + +| Issue | Solution | +|-------|----------| +| **Server failed to start** | Update to .NET 8 SDK or higher, verify JSON syntax in the config file, and restart your IDE. | +| **Invalid API key** | Verify your key is active at the [Syncfusion Account Page](https://syncfusion.com/account/api-key). | +| **Incorrect API key config** | For the file path: verify file location and content. For inline key: check the key is correctly updated. | +| **Wrong config file location** | VS Code: `.vscode/mcp.json` • Code Studio: `.codestudio/mcp.json` • Cursor: `.cursor/mcp.json` in the workspace root. | +| **Check IDE logs** | VS Code / Code Studio: Output panel → "MCP" • Cursor: Developer Console for MCP errors. | +| **Document processing not working** | Ensure the NuGet package for the specific library (PDF, Word, Excel, PowerPoint, Markdown) is installed and properly referenced. | + +## Privacy & Security + +The Syncfusion® MCP Servers are designed with privacy considerations: + +* The tools process requests according to the user's query without storing any content or prompts. +* User prompts are not stored or used for other purposes. +* Prompts are not used to train Syncfusion models. +* The assistant provides context; the final output is produced by the selected AI model. + +The MCP Server acts purely as a knowledge bridge, connecting your AI model with Syncfusion-specific expertise while respecting your privacy and maintaining security. + +## See also + +- [Model Context Protocol](https://modelcontextprotocol.io/docs/2026-07-28/getting-started/intro) \ No newline at end of file