Syncfusion Blazor Smart PDF Viewer MCP Server

31 Jul 202615 minutes to read

Syncfusion^® Blazor Smart PDF Viewer MCP Server accelerates Blazor Smart PDF Viewer application development by providing deep knowledge directly in your AI-powered IDE. Model Context Protocol (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 the AI-powered Blazor Smart PDF Viewer integration, including Document Summarization with Q&A, Smart Redaction, and Smart Fill.

The previously available Agentic UI Builder (#sf_blazor_ui_builder) has been upgraded to an Agent skill-based experience and is no longer part of the MCP Server. To learn more about the new Agentic UI Builder, see the documentation. The AI Coding Assistant (#sf_react_assistant) has been renamed to search_docs (#search_docs) to ensure the tool name follows MCP naming conventions.

Key Benefits

Expert Smart PDF Viewer Knowledge - Deep understanding of the Blazor Smart PDF Viewer component (SfSmartPdfViewer) and its AI-powered 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 or later
A compatible MCP client (VS Code, Syncfusion^® Code Studio, Cursor, JetBrains, etc.)
An active Syncfusion^® API key
A Blazor application (existing or new); see Blazor Smart PDF Viewer documentation
An active Syncfusion^® license (any of the following):

Getting Your API Key

Generate the Syncfusion^® API key from the API Key page and store it in a .txt or .key file. The saved file will be referenced in the MCP configuration:

"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 :

VS Code
Code Studio
Cursor
JetBrains
// Create a `.vscode/mcp.json` file in your workspace:

{
  "servers": {
    "sf-blazor-mcp": {
      "type": "stdio",
      "command": "dnx",
      "args": ["Syncfusion.Blazor.MCP", "--yes"],
      "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:

{
  "servers": {
    "sf-blazor-mcp": {
      "type": "stdio",
      "command": "dnx",
      "args": ["Syncfusion.Blazor.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.
// Create a `.cursor/mcp.json` file in your workspace:

{
  "mcpServers": {
    "sf-blazor-mcp": {
      "command": "dnx",
      "args": ["Syncfusion.Blazor.MCP", "--yes"],
      "env": {
        "Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH"
        // or
        // "Syncfusion_API_Key": "YOUR_API_KEY"
      }
    }
  }
}
// Open AI Assistant chat, type /, and select Add Command.
// Click ➕ Add on the MCP settings page.
// Choose STDIO and select JSON configuration:

{
  "mcpServers": {
    "sf-blazor-mcp": {
      "command": "dnx",
      "args": ["Syncfusion.Blazor.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.

For .NET 8 / .NET 9 (using a local tool):

You can install the Syncfusion Blazor MCP Server as a local tool without requiring a global installation. For guidance on installing and managing local .NET tools, refer to the documentation.

Install the Syncfusion Blazor MCP tool locally:
```
 dotnet tool install Syncfusion.Blazor.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.

In your MCP client config (.vscode/mcp.json), replace the server entry with:

 {
   "servers": {
     "sf-blazor-mcp": {
       "type": "stdio",
       "command": "dotnet",
       "args": ["tool", "run", "syncfusion-blazor-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-blazor-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 Blazor Smart PDF Viewer 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 the Blazor Smart PDF Viewer component.

Component Configuration

#search_docs How do I configure the Syncfusion Blazor Smart PDF Viewer component?

Implement Features

Get step-by-step help for adding the AI-powered features of the Blazor Smart PDF Viewer.

Summarize with Streaming

#search_docs How can I enable Summarize feature and StreamResponse in the Blazor Smart PDF Viewer?

Smart Redaction

#search_docs How can I enable Smart Redaction feature and modify the redaction patterns in the Blazor Smart PDF Viewer?

Smart Fill

#search_docs How can I enable Smart Fill feature in the Blazor Smart PDF Viewer?

Localization & Customization

Tailor the Blazor Smart PDF Viewer to support right-to-left layouts and custom AI service providers.

RTL Support

#search_docs How to change the RTL for the Blazor Smart PDF Viewer?

Custom AI Service with User Token

#search_docs How to use user token with Custom AI service in Blazor Smart PDF Viewer?

Best Practices

To get the most out of the Syncfusion^® Blazor Smart PDF Viewer MCP Server:

Be Specific - Include the component and AI feature in your queries (for example, “Enable Smart Redaction with custom patterns in the Blazor Smart PDF Viewer”).
Provide Context - Include applicable versions, expected outcomes, AI service details, 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 Blazor project.
Start Fresh for New Topics - Begin a new chat when switching to a different feature 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 or support 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.
Incorrect API key config	For the file path: verify file location and content. For inline key: check the key is correctly updated.
AI service not responding	Confirm the configured AI service (Syncfusion^® AI, Azure OpenAI, or Custom AI) credentials, endpoint, and user token are valid.
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.

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.

Search docs

Ask Syncfusion AI Assistant