Skip to content

Commit 79ea40f

Browse files
Merge pull request #1256 from syncfusion-content/Modify-mcp-server-doc-content
Update the api key filepath support content in the mcp document for WinUI platform
2 parents aa40794 + 7a17504 commit 79ea40f

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

winui/AI-Coding-Assistant/mcp-server.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,33 @@ Before you can invoke the `SyncfusionWinUIAssistant` MCP server, you need to con
5454
- **Arguments**: -y
5555
- **Server name**: SyncfusionWinUIAssistant
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+
#### API Key Configuration
5858

59-
```json
60-
"env": {
61-
"Syncfusion_API_Key": "YOUR_API_KEY"
62-
}
63-
```
59+
Login to your [Syncfusion account](http://syncfusion.com/account/) and generate an API Key from the [API Key page](https://www.syncfusion.com/account/api-key). Replace `YOUR_API_KEY_FILE_PATH` or `YOUR_API_KEY` in the configuration files with your generated key.
60+
61+
There are two options:
62+
63+
* **Using an API Key File (Recommended)**
64+
65+
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.
66+
67+
**Supported file formats:** `.txt` or `.key` file
68+
69+
```json
70+
"env": {
71+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // "D:\\syncfusion-key.txt" (or) "D:\\syncfusion-key.key"
72+
}
73+
```
74+
75+
* **Direct API Key**
76+
77+
Paste your `Syncfusion_API_Key` directly in the configuration file's environment parameter.
78+
79+
```json
80+
"env": {
81+
"Syncfusion_API_Key": "YOUR_API_KEY"
82+
}
83+
```
6484

6585
Below are setup instructions for popular MCP clients:
6686

0 commit comments

Comments
 (0)