Skip to content

Commit 4a77e57

Browse files
Merge branch 'development' into 998697-updated-snippets
2 parents 7baba49 + 9948389 commit 4a77e57

File tree

2 files changed

+68
-16
lines changed

2 files changed

+68
-16
lines changed

ej2-asp-core-mvc/EJ2_ASP.MVC/ai-coding-assistant/mcp-server.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,31 @@ Before you can invoke the `SyncfusionAspNetMvcAssistant` MCP server, you need to
5555
- **Arguments**: -y
5656
- **Server name**: SyncfusionAspNetMvcAssistant
5757

58-
You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file:
58+
#### API Key Configuration
5959

60-
```json
61-
"env": {
62-
"Syncfusion_API_Key": "YOUR_API_KEY"
63-
}
64-
```
60+
There are two options:
61+
62+
* **Using an API Key File (Recommended)**
63+
64+
Store your API key in a separate file and reference its path in the `Syncfusion_API_Key_Path` environment parameter. This approach is more secure as you don't expose the key directly in configuration files.
65+
66+
**Supported file formats:** `.txt` or `.key` file
67+
68+
```json
69+
"env": {
70+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // "D:\\syncfusion-key.txt" (or) "D:\\syncfusion-key.key"
71+
}
72+
```
73+
74+
* **Direct API Key**
75+
76+
Paste your `Syncfusion_API_Key` directly in the configuration file's environment parameter.
77+
78+
```json
79+
"env": {
80+
"Syncfusion_API_Key": "YOUR_API_KEY"
81+
}
82+
```
6583

6684
Below are setup instructions for popular MCP clients:
6785

@@ -88,6 +106,8 @@ Below are setup instructions for popular MCP clients:
88106
"@syncfusion/aspnetmvc-assistant@latest"
89107
],
90108
"env": {
109+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
110+
// or
91111
"Syncfusion_API_Key": "YOUR_API_KEY"
92112
}
93113
}
@@ -116,6 +136,8 @@ Below are setup instructions for popular MCP clients:
116136
"@syncfusion/aspnetmvc-assistant@latest"
117137
],
118138
"env": {
139+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
140+
// or
119141
"Syncfusion_API_Key": "YOUR_API_KEY"
120142
}
121143
}
@@ -142,7 +164,9 @@ To configure an MCP server for a specific workspace, you can create a `.cursor/m
142164
"@syncfusion/aspnetmvc-assistant@latest"
143165
],
144166
"env": {
145-
"Syncfusion_API_Key": "YOUR_API_KEY"
167+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
168+
// or
169+
"Syncfusion_API_Key": "YOUR_API_KEY"
146170
}
147171
}
148172
}
@@ -167,7 +191,9 @@ For more details, refer to the [Cursor documentation](https://cursor.com/docs/co
167191
"@syncfusion/aspnetmvc-assistant@latest"
168192
],
169193
"env": {
170-
"Syncfusion_API_Key": "YOUR_API_KEY"
194+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
195+
// or
196+
"Syncfusion_API_Key": "YOUR_API_KEY"
171197
}
172198
}
173199
}

ej2-asp-core-mvc/EJ2_ASP.NETCORE/ai-coding-assistant/mcp-server.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,31 @@ Before you can invoke the `SyncfusionAspNetCoreAssistant` MCP server, you need t
5555
- **Arguments**: -y
5656
- **Server name**: syncfusionAspNetCoreAssistant
5757

58-
You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file:
58+
#### API Key Configuration
5959

60-
```json
61-
"env": {
62-
"Syncfusion_API_Key": "YOUR_API_KEY"
63-
}
64-
```
60+
There are two options:
61+
62+
* **Using an API Key File (Recommended)**
63+
64+
Store your API key in a separate file and reference its path in the `Syncfusion_API_Key_Path` environment parameter. This approach is more secure as you don't expose the key directly in configuration files.
65+
66+
**Supported file formats:** `.txt` or `.key` file
67+
68+
```json
69+
"env": {
70+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // "D:\\syncfusion-key.txt" (or) "D:\\syncfusion-key.key"
71+
}
72+
```
73+
74+
* **Direct API Key**
75+
76+
Paste your `Syncfusion_API_Key` directly in the configuration file's environment parameter.
77+
78+
```json
79+
"env": {
80+
"Syncfusion_API_Key": "YOUR_API_KEY"
81+
}
82+
```
6583

6684
Below are setup instructions for popular MCP clients:
6785

@@ -88,6 +106,8 @@ Below are setup instructions for popular MCP clients:
88106
"@syncfusion/aspnetcore-assistant@latest"
89107
],
90108
"env": {
109+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
110+
// or
91111
"Syncfusion_API_Key": "YOUR_API_KEY"
92112
}
93113
}
@@ -116,6 +136,8 @@ Below are setup instructions for popular MCP clients:
116136
"@syncfusion/aspnetcore-assistant@latest"
117137
],
118138
"env": {
139+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
140+
// or
119141
"Syncfusion_API_Key": "YOUR_API_KEY"
120142
}
121143
}
@@ -142,7 +164,9 @@ To configure an MCP server for a specific workspace, you can create a `.cursor/m
142164
"@syncfusion/aspnetcore-assistant@latest"
143165
],
144166
"env": {
145-
"Syncfusion_API_Key": "YOUR_API_KEY"
167+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
168+
// or
169+
"Syncfusion_API_Key": "YOUR_API_KEY"
146170
}
147171
}
148172
}
@@ -167,7 +191,9 @@ For more details, refer to the [Cursor documentation](https://cursor.com/docs/co
167191
"@syncfusion/aspnetcore-assistant@latest"
168192
],
169193
"env": {
170-
"Syncfusion_API_Key": "YOUR_API_KEY"
194+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
195+
// or
196+
"Syncfusion_API_Key": "YOUR_API_KEY"
171197
}
172198
}
173199
}

0 commit comments

Comments
 (0)