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
1 change: 1 addition & 0 deletions Document-Processing-toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -2370,6 +2370,7 @@
<ul>
<li><a href="/document-processing/pdf/pdf-viewer/maui/Getting-Started">Getting Started</a></li>
<li><a href="/document-processing/pdf/pdf-viewer/maui/ui-builder-skill">Agentic UI Builder Skill</a></li>
<li><a href="/document-processing/pdf/pdf-viewer/maui/mcp">MCP Server</a></li>
<li><a href="/document-processing/pdf/pdf-viewer/maui/Migration">Migrate from Xamarin.Forms</a></li>
<li>
<a href="/document-processing/pdf/pdf-viewer/maui/Open-a-Document">Open a Document</a>
Expand Down
264 changes: 264 additions & 0 deletions Document-Processing/PDF/PDF-Viewer/maui/mcp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,264 @@
---
layout: post
title: Syncfusion MAUI MCP Server | Syncfusion
description: Learn how to configure and use Syncfusion MAUI MCP server for intelligent code generation, documentation, and troubleshooting in .NET MAUI apps.
platform: MAUI
control: Getting started with Syncfusion MAUI MCP Server
documentation: ug
---

# Syncfusion MAUI MCP Server

Syncfusion<sup style="font-size:70%">&reg;</sup> MCP Server accelerate .NET MAUI application development by providing deep knowledge directly in your AI-powered IDE. [Model Context Protocol](https://modelcontextprotocol.io/docs/2026-07-28/getting-started/intro) (MCP) integration enables quick access to documentation, API references, and code-generation features from within the development environment.

These tools speed up development and reinforce best practices for Syncfusion component integration.

## Key Benefits

- **Expert Component Knowledge** - Deep understanding of 100+ MAUI components and their implementation patterns.
- **Unlimited Usage** - No request limits, time restrictions, or query caps.
- **Privacy-Focused** - The tools operate based on the user's query and do not store any content, data, or prompts.

## Installation

### Prerequisites

Before beginning, ensure the following prerequisites are met:

- Microsoft [.NET SDK 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) or later
- A **compatible MCP client** (VS Code, Syncfusion<sup style="font-size:70%">&reg;</sup> Code Studio, Cursor, JetBrains, etc.)
- An active [Syncfusion<sup style="font-size:70%">&reg;</sup> API key](https://syncfusion.com/account/api-key)
- A **.NET MAUI application** (existing or new); see [MAUI application that includes Syncfusion MAUI](https://help.syncfusion.com/maui/introduction/overview)
- An active Syncfusion<sup style="font-size:70%">&reg;</sup> license (any of the following):
- [Commercial License](https://www.syncfusion.com/sales/unlimitedlicense)
- [Free Community License](https://www.syncfusion.com/products/communitylicense)
- [Free Trial](https://www.syncfusion.com/account/manage-trials/start-trials)

### Getting Your API Key

Generate the Syncfusion<sup style="font-size:70%">&reg;</sup> API key from the [API Key page](https://www.syncfusion.com/account/api-key) and store it in a `.txt` or `.key` file. The saved file will be referenced in the MCP configuration:

````json
"env": {
"Syncfusion_API_Key_Path": "D:\\syncfusion-key.txt"
}
````

> Alternatively, the API key can also be set directly using `"Syncfusion_API_Key": "YOUR_API_KEY"` in the env configuration. Using a file path is recommended to keep the key out of source control.

### Setting Up in MCP Clients

Create a configuration file in your project folder to install the server for your workspace. **Replace `YOUR_API_KEY_FILE_PATH` with the path to your API key file.** The tabs below show a working configuration for each supported MCP client.

**For .NET 10** :

{% tabs %}
{% highlight bash tabtitle="VS Code" %}

// Create a `.vscode/mcp.json` file in your workspace:

{
"servers": {
"sf-maui-mcp": {
"type": "stdio",
"command": "dnx",
"args": ["Syncfusion.Maui.MCP", "--yes"],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH"
// or
// "Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}

{% endhighlight %}
{% highlight bash tabtitle="Code Studio" %}

// Create a `.codestudio/mcp.json` file in your workspace:

{
"servers": {
"sf-maui-mcp": {
"type": "stdio",
"command": "dnx",
"args": ["Syncfusion.Maui.MCP", "--yes"],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH"
// or
// "Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}

// After creating the file, click Start in the inline action to install the server.

{% endhighlight %}
{% highlight bash tabtitle="Cursor" %}

// Create a `.cursor/mcp.json` file in your workspace:

{
"mcpServers": {
"sf-maui-mcp": {
"command": "dnx",
"args": ["Syncfusion.Maui.MCP", "--yes"],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH"
// or
// "Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}

{% endhighlight %}
{% highlight bash tabtitle="JetBrains" %}

// Open AI Assistant chat, type /, and select Add Command.
// Click ➕ Add on the MCP settings page.
// Choose STDIO and select JSON configuration:

{
"mcpServers": {
"sf-maui-mcp": {
"command": "dnx",
"args": ["Syncfusion.Maui.MCP", "--yes"],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH"
// or
// "Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}

// Click OK, then click Apply. The server starts and shows Connected status.

{% endhighlight %}
{% endtabs %}

**For .NET 8 / .NET 9 (using a local tool):**

You can install the Syncfusion MAUI MCP server as a local tool without a global installation. For guidance on installing and managing local .NET tools, refer to the [documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use).

1. Install the Syncfusion MAUI MCP tool locally:

````bash
dotnet tool install Syncfusion.MAUI.MCP
````

2. In your MCP client config (for example, `.vscode/mcp.json`), replace the server entry with:

````json
{
"servers": {
"sf-maui-mcp": {
"type": "stdio",
"command": "dotnet",
"args": ["tool", "run", "syncfusion-maui-mcp"],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH"
// or
// "Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}
````

**Verifying Installation** Check your editor's MCP Server list for `sf-maui-mcp` with a **Connected** status to confirm a successful installation.

## Common use cases

The examples below showcase how the `search_docs` tool handles real-world MAUI development scenarios. The tool can be invoked directly, as shown in the examples below, for specific needs. Alternatively, an AI assistant can automatically invoke it based on the request.

**Get Started**

Use `search_docs` to get contextual guidance, code snippets, and configuration examples for any component.

{% promptcards %}
{% promptcard Grid with Paging & Sorting %}
#search_docs Create a Syncfusion MAUI Grid with paging, sorting, and filtering enabled.
{% endpromptcard %}
{% endpromptcards %}

{% promptcards %}
{% promptcard Scheduler Setup %}
#search_docs How do I set up the Syncfusion MAUI Scheduler with custom event configuration and data binding?
{% endpromptcard %}
{% endpromptcards %}

**Implement Features**

Get step-by-step help for adding specific features to components that are already in the project.

{% promptcards %}
{% promptcard Grid Export %}
#search_docs How can I add PDF and Excel export options to my existing Grid's toolbar?
{% endpromptcard %}
{% endpromptcards %}

{% promptcards %}
{% promptcard Kanban Features %}
#search_docs How do I enable drag-and-drop and custom scheduling in the Schedule control?
{% endpromptcard %}
{% endpromptcards %}

**Troubleshooting**

Describe the problem in plain language, and let `search_docs` help resolve it.
{% promptcards %}
{% promptcard Grid Issues %}
#search_docs Why isn't my Grid loading or rendering data correctly?
{% endpromptcard %}
{% endpromptcards %}

{% promptcards %}
{% promptcard Schedule Issues %}
#search_docs Why aren't my Schedule events displaying or saving correctly?
{% endpromptcard %}
{% endpromptcards %}

## Best Practices

To get the most out of the Syncfusion<sup style="font-size:70%">&reg;</sup> MAUI MCP Servers:

- **Be Specific** - Include the platform and component in your queries (for example, *"Create a Syncfusion MAUI Grid with sorting and filtering"*).
- **Provide Context** - Include applicable versions, expected outcomes, and any requirements or limitations that may affect the request.
- **Use Descriptive Queries** - Avoid overly brief or ambiguous requests. Providing sufficient detail helps improve the accuracy and relevance of the response.
- **Stay Consistent** - Keep file organization, naming conventions, and coding standards consistent throughout your MAUI project.
- **Start Fresh for New Topics** - Begin a new chat when switching to a different component or task to maintain clean context.
- **Use Advanced AI Models** - For the best results, use advanced AI models such as the latest-generation **Claude**, **GPT**, or **Gemini** models.
- **For Troubleshooting** - Use AI suggestions for common issues; consult the [official documentation](https://help.syncfusion.com/maui/introduction/overview) or [support](https://support.syncfusion.com/support/tickets/create) for complex problems.
- **Minimize Active Tools** - Limit the number of active MCP tools in your IDE to prevent tool-selection ambiguity and improve response accuracy.

> Always review AI-generated code before using it in production.

## Troubleshooting

The table below lists frequently encountered issues and suggested resolutions to help diagnose and address common setup or usage challenges.

| Issue | Solution |
|-------|----------|
| **Server failed to start** | Update to .NET 8 SDK or higher, verify JSON syntax in the config file, and restart your IDE. |
| **Invalid API key** | Verify your key is active at the [Syncfusion Account Page](https://syncfusion.com/account/api-key). |
| **Incorrect API key config** | For the file path: verify file location and content. For inline key: check the key is correctly updated. |
| **Wrong config file location** | VS Code: `.vscode/mcp.json` • Code Studio: `.codestudio/mcp.json` • Cursor: `.cursor/mcp.json` in the workspace root. |
| **Check IDE logs** | VS Code / Code Studio: Output panel → "MCP" • Cursor: Developer Console for MCP errors. |

## Privacy & Security

The Syncfusion<sup style="font-size:70%">&reg;</sup> MCP Servers are designed with privacy considerations:

* The tools process requests according to the user's query without storing any content or prompts.
* User prompts are not stored or used for other purposes.
* Prompts are not used to train Syncfusion models.
* The assistant provides context; the final output is produced by the selected AI model.

The MCP Server acts purely as a knowledge bridge, connecting your AI model with Syncfusion-specific expertise while respecting your privacy and maintaining security.

## See also

- [Model Context Protocol](https://modelcontextprotocol.io/docs/2026-07-28/getting-started/intro)