Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 34 additions & 6 deletions MAUI/AI-Coding-Assistant/mcp-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,33 @@ Before you can invoke the `SyncfusionMAUIAssistant` MCP server, you need to conf
- **Arguments**: -y
- **Server name**: syncfusionMAUIAssistant

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 All @@ -87,6 +107,8 @@ Below are setup instructions for popular MCP clients:
"@syncfusion/maui-assistant@latest"
],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
// or
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
Expand Down Expand Up @@ -115,6 +137,8 @@ Below are setup instructions for popular MCP clients:
"@syncfusion/maui-assistant@latest"
],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
// or
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
Expand All @@ -141,6 +165,8 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
"@syncfusion/maui-assistant@latest"
],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
// or
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
Expand All @@ -165,6 +191,8 @@ For more details, refer to the [Cursor documentation](https://cursor.com/docs/co
"@syncfusion/maui-assistant@latest"
],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
// or
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
Expand Down
1 change: 1 addition & 0 deletions MAUI/AI-Coding-Assistant/prompt-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,7 @@ The Syncfusion .NET MAUI ListView provides a high-performance, flexible list wit

The Syncfusion .NET MAUI AI AssistView provides a ready-made conversational UI for integrating LLMs with features like message list, input box, suggestions, attachments, and tool/action invocation.

{% promptcards %}
{% promptcard Messages %}
#SyncfusionMAUIAssistant Bind AssistView to a message collection with system, user, and pre load conversation history.
{% endpromptcard %}
Expand Down