Skip to content

Update the api key filepath support content in the mcp document for WinUI platform #1256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JeganRavichandran merged 1 commit into from
Dec 17, 2025
Merged

Update the api key filepath support content in the mcp document for WinUI platform #1256

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions winui/AI-Coding-Assistant/mcp-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,33 @@ Before you can invoke the `SyncfusionWinUIAssistant` MCP server, you need to con
- **Arguments**: -y
- **Server name**: SyncfusionWinUIAssistant

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

```json
"env": {
"Syncfusion_API_Key": "YOUR_API_KEY"
}
```
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.

There are two options:

* **Using an API Key File (Recommended)**

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.

**Supported file formats:** `.txt` or `.key` file

```json
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // "D:\\syncfusion-key.txt" (or) "D:\\syncfusion-key.key"
}
```

* **Direct API Key**

Paste your `Syncfusion_API_Key` directly in the configuration file's environment parameter.

```json
"env": {
"Syncfusion_API_Key": "YOUR_API_KEY"
}
```

Below are setup instructions for popular MCP clients:

Expand Down