You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: blazor/ai-coding-assistants/mcp-server.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,19 +62,19 @@ You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key
62
62
}
63
63
```
64
64
65
-
[SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) can be configured in various MCP clients. Below are setup instructions for popular environment:
65
+
Below are setup instructions for popular MCP clients:
66
66
67
67
### Syncfusion<supstyle="font-size:70%">®</sup> Code Studio
68
68
69
69
* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the `Custom Servers` tab.
70
70
* Enter the Server Name as `blazor-mcp`, choose Server Type as npm package, and set the NPM Package name to `@syncfusion/blazor-assistant`.
71
71
* 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**.
72
72
* Once installed, the server will appear in the User Installed Server list, and will be added to the **config.yaml** file.
73
-
* 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#npm-server).
73
+
* 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#npm-server).
74
74
75
75
### VS Code (GitHub Copilot MCP)
76
76
77
-
1. To configure an MCP server for a specific workspace, you can create a `.vscode/mcp.json` file in your workspace folder.
77
+
* To configure an MCP server for a specific workspace, you can create a `.vscode/mcp.json` file in your workspace folder.
78
78
79
79
```json
80
80
{
@@ -94,14 +94,15 @@ You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key
94
94
}
95
95
```
96
96
97
-
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 [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) server directly from the settings interface without additional commands.
97
+
* 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.
98
98
99
-
3. Confirm that [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant) is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
100
-
*`SyncfusionBlazorAssistant is running...` (in VS Code)
99
+
* Confirm the server is active by checking for a message like: `SyncfusionBlazorAssistant is running...` in the output.
100
+
101
+
* For additional guidance, refer to the [VS Code documentation](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_add-an-mcp-server).
101
102
102
103
### Cursor
103
104
104
-
To configure an MCP server for a specific workspace, you can create a .cursor/mcp.json file in your workspace folder.
105
+
To configure an MCP server for a specific workspace, you can create a `.cursor/mcp.json` file in your workspace folder.
105
106
106
107
```json
107
108
{
@@ -121,11 +122,13 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
121
122
}
122
123
```
123
124
125
+
For more details, refer to the [Cursor documentation](https://cursor.com/docs/context/mcp#using-mcp-json).
126
+
124
127
### JetBrains IDEs
125
128
126
-
1. Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP).
127
-
2. Click + Add to add a new MCP server configuration.
128
-
3. In the New MCP Server dialog, switch the dropdown as `As JSON` and add the following config:
129
+
* Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP).
130
+
* Click + Add to add a new MCP server configuration.
131
+
* In the New MCP Server dialog, switch the dropdown as `As JSON` and add the following config:
129
132
130
133
```json
131
134
{
@@ -144,13 +147,10 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
144
147
}
145
148
```
146
149
147
-
4. Click OK and Apply.
150
+
* Click OK and Apply.
151
+
* For further assistance, see the [JetBrains documentation](https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server).
148
152
149
-
> For more detailed information about configuring MCP servers in various clients, refer to the official documentations.
> 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)
154
154
155
155
## Usage
156
156
@@ -164,9 +164,9 @@ To activate the SyncfusionBlazorAssistant MCP server:
164
164
* '@ask_syncfusion_blazor'
165
165
* 'ej2-blazor'
166
166
167
-
In VS Code, you can also use #SyncfusionBlazorAssistant to explicitly invoke the MCP server.
167
+
In VS Code, use `#SyncfusionBlazorAssistant` for direct invocation.
168
168
169
-
2. Grant the SyncfusionBlazorAssistant MCP server a permission to run for this session, workspace, or always.
169
+
2. Grant permission for the server to run (for the session, workspace, or always).
170
170
3. For best results, start a new chat for each new topic to maintain clean context.
171
171
172
172
### Mode availability
@@ -184,9 +184,9 @@ Syncfusion<sup style="font-size:70%">®</sup> MCP Servers provide full access
184
184
185
185
Here are some effective ways to use [SyncfusionBlazorAssistant](https://www.npmjs.com/package/@syncfusion/blazor-assistant):
186
186
187
-
* "Create a Syncfusion Blazor Grid component with paging, sorting and filtering"
187
+
* "Create a Syncfusion Blazor Grid component with paging, sorting and filtering."
188
188
* "How do I implement data binding with Syncfusion Blazor scheduler?"
189
-
* "Show me how to create a dashboard with multiple Syncfusion components"
189
+
* "Show me how to create a dashboard with multiple Syncfusion components."
0 commit comments