Skip to content

Commit fcce99d

Browse files
Merge pull request #7093 from syncfusion-content/985454-UG
Updated the Blazor common UG documentation
2 parents aaf9fbc + 32f0978 commit fcce99d

27 files changed

+443
-444
lines changed

blazor/ai-coding-assistant/mcp-server.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
layout: post
3-
title: SyncfusionBlazorAssistant MCP Server | Syncfusion
4-
description: Learn how to configure and use SyncfusionBlazorAssistant MCP server for intelligent code generation, documentation, and troubleshooting in Blazor apps.
3+
title: SyncfusionBlazorAssistant MCP server | Syncfusion
4+
description: Learn how to configure and use SyncfusionBlazorAssistant MCP server for intelligent code generation, documentation, and troubleshooting in Blazor applications.
55
control: Getting started with SyncfusionBlazorAssistant MCP Server
66
platform: Blazor
77
documentation: ug
88
---
99

10-
# SyncfusionBlazorAssistant MCP Server
10+
# SyncfusionBlazorAssistant MCP server
1111

1212
## Overview
1313

14-
The [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides intelligent assistance for developers using Syncfusion's Blazor component libraries. This tool seamlessly integrates with compatible [MCP clients](https://modelcontextprotocol.io/clients) to enhance your development workflow when building Blazor applications with Syncfusion<sup style="font-size:70%">&reg;</sup> components.
14+
The [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides intelligent assistance for developers using Syncfusion Blazor component libraries. This tool seamlessly integrates with compatible [MCP clients](https://modelcontextprotocol.io/clients) to enhance your development workflow when building Blazor applications with Syncfusion<sup style="font-size:70%">&reg;</sup> components.
1515

16-
### Key Benefits
16+
### Key benefits
1717

1818
* Intelligent code generation for Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components.
1919
* Detailed component documentation and usage examples.
@@ -23,15 +23,15 @@ The [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor
2323

2424
Before using [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant), ensure you have:
2525

26-
* Required [node](https://nodejs.org/en/) version >= 18
27-
* A [compatible MCP client](https://modelcontextprotocol.io/clients) (Visual Studio Code with GitHub Copilot, [Syncfusion<sup style="font-size:70%">&reg;</sup> CodeStudio](https://www.syncfusion.com/code-studio/), etc.)
26+
* Required [Node.js](https://nodejs.org/en/) version >= 18
27+
* A [compatible MCP client](https://modelcontextprotocol.io/clients) (Visual Studio Code with GitHub Copilot, [Syncfusion<sup style="font-size:70%">&reg;</sup> Code Studio](https://www.syncfusion.com/code-studio/), etc.)
2828
* An active Syncfusion<sup style="font-size:70%">&reg;</sup> license (any of the following):
2929
- [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense)
3030
- [Free Community License](https://www.syncfusion.com/products/communitylicense)
3131
- [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials)
32-
* An active [API KEY](https://syncfusion.com/account/api-key)
32+
* An active [API key](https://www.syncfusion.com/account/api-key)
3333

34-
## Unlimited Access
34+
## Unlimited access
3535

3636
Syncfusion<sup style="font-size:70%">&reg;</sup> offers unlimited access to this MCP server. There are no restrictions on:
3737

@@ -46,15 +46,15 @@ This ensures users can fully leverage Syncfusion<sup style="font-size:70%">&reg;
4646

4747
Before you can invoke the `SyncfusionBlazorAssistant` 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:
4848

49-
### Generic MCP Server Settings
49+
### Generic MCP server settings
5050

5151
- **npm package name**: `@syncfusion/blazor-assistant`
5252
- **Type**: stdio (standard input/output transport)
5353
- **Command**: npx
5454
- **Arguments**: -y
5555
- **Server name**: syncfusionBlazorAssistant
5656

57-
You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file:
57+
You need to add your [Syncfusion API key](https://www.syncfusion.com/account/api-key) as an env parameter in the configuration file:
5858

5959
```json
6060
"env": {
@@ -93,7 +93,7 @@ Below are setup instructions for popular MCP clients:
9393
}
9494
```
9595

96-
* 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 [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) server directly from the settings interface without additional commands.
96+
* After updating the configuration in mcp.json, you'll notice a "Start" option at the top of the config. This allows you to easily start the [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) server directly from the settings interface without additional commands.
9797

9898
* Confirm the server is active by checking for a message like: `SyncfusionBlazorAssistant is running...` in the output.
9999

@@ -176,7 +176,7 @@ For more details, refer to the [Cursor documentation](https://cursor.com/docs/co
176176

177177
For further assistance, see the [JetBrains documentation](https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server).
178178

179-
> 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)
179+
> For more detailed information about configuring MCP servers in various clients, refer to the official documentation, e.g., [Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json)
180180
181181
## Usage
182182

@@ -199,7 +199,7 @@ To activate the SyncfusionBlazorAssistant MCP server:
199199

200200
Syncfusion<sup style="font-size:70%">&reg;</sup> MCP Servers provide full access to all AI interaction modes — Ask/Chat, Edit, and Agent — across supported MCP clients.
201201

202-
### Best Practices for Effective Usage
202+
### Best practices for effective usage
203203

204204
1. `Be specific`: Mention both platform and component (e.g., "How do I create a Syncfusion Blazor Grid with paging and filtering?").
205205
2. `Provide context`: Include details about your use case for more targeted solutions.
@@ -225,7 +225,7 @@ If you encounter issues:
225225

226226
## Support
227227

228-
Product support is available through the following mediums.
228+
Product support is available through the following channels.
229229

230230
* [Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours \| Unlimited tickets \| Holiday support
231231
* [Community forum](https://www.syncfusion.com/forums/blazor-components)
@@ -234,4 +234,4 @@ Product support is available through the following mediums.
234234

235235
## See also
236236

237-
* [Syncfusion Blazor Documentation](https://blazor.syncfusion.com/documentation)
237+
* [Syncfusion Blazor documentation](https://blazor.syncfusion.com/documentation)
Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
---
22
layout: post
3-
title: Syncfusion AI Coding Assistant Overview | Syncfusion
4-
description: Learn how Syncfusion AI Coding Assistant boost Blazor productivity by generating accurate code snippets, configuration examples, and contextual guidance.
3+
title: Syncfusion AI Coding Assistant overview | Syncfusion
4+
description: Learn how the Syncfusion AI Coding Assistant boosts Blazor productivity by generating accurate code snippets, configuration examples, and contextual guidance.
55
control: Syncfusion AI Coding Assistant Overview
66
platform: Blazor
77
documentation: ug
88
---
99

10-
# Syncfusion® AI Coding Assistant Overview
10+
# Syncfusion® AI Coding Assistant overview
1111

12-
The **Syncfusion<sup style="font-size:70%">&reg;</sup> AI Coding Assistant** are designed to streamline your development workflow when building Blazor applications with Syncfusion<sup style="font-size:70%">&reg;</sup> components. It uses contextual knowledge of the Syncfusion<sup style="font-size:70%">&reg;</sup> component library to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity.
12+
The **Syncfusion<sup style="font-size:70%">&reg;</sup> AI Coding Assistant** is designed to streamline development when building Blazor applications with Syncfusion<sup style="font-size:70%">&reg;</sup> components. It uses contextual knowledge of the Syncfusion<sup style="font-size:70%">&reg;</sup> component library to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity.
1313

14-
AI Coding Assistant:
14+
AI Coding Assistants:
1515

16-
* **The SyncfusionBlazorAssistant MCP Server**
17-
Processes advanced prompts and returns tailored code suggestions via [MCP-compatible clients](https://modelcontextprotocol.io/clients).
16+
* **SyncfusionBlazorAssistant MCP server**
17+
Processes prompts and returns tailored code suggestions through [MCP-compatible clients](https://modelcontextprotocol.io/clients).
1818

19-
## Getting Started
19+
## Getting started
2020

21-
To use the AI Coding Assistant, you need:
21+
To use the AI Coding Assistant, the following are required:
2222

2323
* A [Syncfusion<sup style="font-size:70%">&reg;</sup> user account](https://www.syncfusion.com/account)
2424
* An active Syncfusion<sup style="font-size:70%">&reg;</sup> license (any of the following):
2525
- [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense)
2626
- [Free Community License](https://www.syncfusion.com/products/communitylicense)
2727
- [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials)
28-
* An active [API KEY](https://syncfusion.com/account/api-key)
28+
* An active [API key](https://www.syncfusion.com/account/api-key)
2929
* A [Blazor application that includes SyncfusionBlazor](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app)
3030

31-
## Unlimited Access
31+
## Unlimited access
3232

33-
Syncfusion<sup style="font-size:70%">&reg;</sup> offers unlimited access to the AI Coding Assistant, with no limitations on:
33+
Syncfusion<sup style="font-size:70%">&reg;</sup> offers unlimited access to the AI Coding Assistant with no limitations on:
3434

3535
* Number of requests
3636
* Components usage
@@ -39,31 +39,33 @@ Syncfusion<sup style="font-size:70%">&reg;</sup> offers unlimited access to the
3939

4040
This ensures users can fully leverage Syncfusion<sup style="font-size:70%">&reg;</sup> components to enhance their development experience without limitations.
4141

42-
## Best Practices
42+
## Best practices
4343

4444
* Initial Setup: Use the tools to quickly add and configure Syncfusion<sup style="font-size:70%">&reg;</sup> components in your Blazor application.
4545
* Feature Tuning: Enable or disable component features through prompt-based configuration for tailored functionality.
4646
* Data Binding: Generate sample data for testing and prototyping. Avoid using sensitive or production data to ensure security.
47-
* Step-by-step explanations: Use annotated code to understand component behavior. Note that the level of detail may vary depending on the tool, mode, and AI model used. Refer to the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Documentation](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app) for in-depth information.
47+
* Step-by-step explanations: Use annotated code to understand component behavior. The level of detail may vary based on the tool, mode, and AI model. Refer to the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor documentation](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app) for in-depth information.
48+
* Troubleshooting: Resolve common issues with AI-generated suggestions. For complex problems, see the [documentation](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app) or contact [support](https://support.syncfusion.com/support/tickets/create).
49+
4850
* Troubleshooting: Resolve common issues with AI-generated suggestions. For complex problems, refer to [documentation](https://blazor.syncfusion.com/documentation/getting-started/blazor-web-app) or [support](https://support.syncfusion.com/support/tickets/create).
4951

5052
> Always check AI-generated content and code for accuracy before using it.
5153
5254
## Recommendations
5355

5456
* Session Management: Start new sessions when switching tasks to ensure prompt relevance and maintain content focus.
55-
* Model Compatibility: For optimal performance, use the tools with advanced AI models such as GPT-5 or Claude Sonnet 4.
57+
* Model compatibility: For optimal performance, use the tools with advanced AI models such as GPT-5 or Claude Sonnet 4.
5658

57-
## Privacy & Data Handling
59+
## Privacy and data handling
5860

5961
The Syncfusion<sup style="font-size:70%">&reg;</sup> AI Coding Assistant is designed with privacy in mind:
6062

6163
* The tools do not access your project files or workspace directly.
6264
* User prompts are not stored by any of the tools or used for any other purpose.
6365
* Prompts are not used to train Syncfusion<sup style="font-size:70%">&reg;</sup> models.
64-
* The assistant generates context, while the final output is handled by your selected AI model.
66+
* The assistant provides context, while the final output is generated by the AI model selected in your client.
6567

6668
## See also
6769

68-
* Add the [SyncfusionBlazorAssistant MCP Server](https://blazor.syncfusion.com/documentation/ai-coding-assistant/mcp-server) to an MCP-enabled client
69-
* [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Documentation](https://blazor.syncfusion.com/documentation)
70+
* Add the [SyncfusionBlazorAssistant MCP server](https://blazor.syncfusion.com/documentation/ai-coding-assistant/mcp-server) to an MCP-enabled client
71+
* [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor documentation](https://blazor.syncfusion.com/documentation)

blazor/getting-started/blazor-electron-app.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,54 +9,54 @@ documentation: ug
99

1010
# Creating Desktop Application using Blazor and Electron
1111

12-
This section explains how to create and run desktop applications using Blazor and Electron Framework with Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components.
12+
This section explains how to create and run a desktop application by using Blazor and the Electron.NET framework with Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components.
1313

1414
## What is Electron?
1515

16-
[Electron](https://www.electronjs.org/) framework for building cross-platform desktop applications with web technologies. It utilizes `Node.js` and the `Chromium` rendering engine to run a web application on a desktop shell.
16+
[Electron](https://www.electronjs.org/) is a framework for building cross-platform desktop applications with web technologies. It utilizes `Node.js` and the `Chromium` rendering engine to run a web application in a desktop shell.
1717

1818
## Create a Blazor server-side application
1919

20-
You can create Blazor Server application using either CLI or Visual Studio referring the below links
20+
Create a Blazor Server application by using either the CLI or Visual Studio:
2121

22-
* [Create Blazor server application using CLI](https://blazor.syncfusion.com/documentation/getting-started/blazor-server-side-dotnet-cli)
22+
* [Create a Blazor Server application by using the CLI](https://blazor.syncfusion.com/documentation/getting-started/blazor-server-side-dotnet-cli)
2323

24-
* [Create Blazor Server application using Visual Studio](https://blazor.syncfusion.com/documentation/getting-started/blazor-server-side-visual-studio)
24+
* [Create a Blazor Server application by using Visual Studio](https://blazor.syncfusion.com/documentation/getting-started/blazor-server-side-visual-studio)
2525

26-
N> This setup does not work with Target Frameworks greater than .NET 6. For more details and troubleshooting, refer to this [GitHub thread](https://github.com/ElectronNET/Electron.NET/issues/837#issuecomment-1985434060).
26+
N> This setup does not work with target frameworks greater than .NET 6. For details and troubleshooting, see this [GitHub thread](https://github.com/ElectronNET/Electron.NET/issues/837#issuecomment-1985434060).
2727

2828
## Configure Electron in Blazor App
2929

30-
You can run the below commands either in **Visual Studio Developer Command Prompt** or **CLI** based on the tool you are using for development.
30+
Run the following commands in either the **Visual Studio Developer Command Prompt** or a **command-line interface (CLI)** based on the development environment.
3131

3232
1.Install [ElectronNET.API](https://www.nuget.org/packages/ElectronNET.API/) NuGet package in the application.
3333

3434
```
3535
dotnet add package ElectronNET.API
3636
```
3737

38-
2.Create a local .NET tool manifest file by running the following command. This will create a manifest file in the **~/.config/dotnet-tools.json** location.
38+
2.Create a local .NET tool manifest file by running the following command. This creates a manifest file at **~/.config/dotnet-tools.json** in the current project.
3939

4040
```
4141
dotnet new tool-manifest
4242
```
4343

44-
![.NET tool manifest file](images\electron\net-tool-manifest.png)
44+
![.NET tool manifest file](images/electron/net-tool-manifest.png)
4545

4646
3.Install the tool locally in the project by running the below command.
4747

4848
```
4949
dotnet tool install ElectronNET.CLI
5050
```
5151

52-
![Electron NET CLI](images\electron\net-cli.png)
52+
![Electron.NET CLI installation](images/electron/net-cli.png)
5353

5454
4.Run the below command to configure Electron.NET manifest tool and update the launch profile of the application.
5555

5656
```
5757
dotnet electronize init
5858
```
59-
![Update launch profile](images\electron\update-launch-profile.png)
59+
![Update launch profile for Electron.NET](images/electron/update-launch-profile.png)
6060

6161
5.To integrate `Electron.NET` in the application add the below code in **~/Program.cs** file of the application.
6262

@@ -113,9 +113,9 @@ var app = builder.Build();
113113
dotnet electronize start
114114
```
115115

116-
![Electron app output](images\electron\electron-grid-output.png)
116+
![Electron app output](images/electron/electron-grid-output.png)
117117

118-
N> To close the electron app when closed the electron window add the below code in **//Open the Electron-Window** in step 6 in the **~/Program.cs** file of .NET 6 application.
118+
N> To close the Electron app when the Electron window is closed, add the following code under **// Open the Electron-Window** in step 6 in the **~/Program.cs** file of a .NET 6 application.
119119

120120
{% tabs %}
121121
{% highlight c# tabtitle=".NET 6 (~/Program.cs)" hl_lines="14 15 16" %}
@@ -145,12 +145,12 @@ var app = builder.Build();
145145
{% endhighlight %}
146146
{% endtabs %}
147147

148-
8.Run the below command lines to do production builds based on platform
148+
8.Run the following commands to create production builds for each platform.
149149

150150
```
151151
dotnet electronize build /target win
152152
dotnet electronize build /target osx
153153
dotnet electronize build /target linux
154154
```
155155

156-
N> [View the complete Blazor Server electron application with Syncfusion<sup style="font-size:70%">&reg;</sup> controls on GitHub](https://github.com/SyncfusionExamples/blazor-electron-app)
156+
N> [View the complete Blazor Server Electron application with Syncfusion<sup style="font-size:70%">&reg;</sup> components on GitHub](https://github.com/SyncfusionExamples/blazor-electron-app)

0 commit comments

Comments
 (0)