-
Notifications
You must be signed in to change notification settings - Fork 30
AI Coding Assistant for MAUI platform Documentation #3752
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.
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
Open
jayaleshwari
wants to merge
26
commits into
master
Choose a base branch
from
CodingAssistant-UG
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
b373ddf
Update Basic-Features.md
NatarajanSF4844 082c3ea
Update Basic-Features.md
NatarajanSF4844 5f19d7c
Create content for Selected dropdown item text style
Manikandan-Kannan-1312 b81deb6
Added ug content for data grid context menu feature
karthikasf4617 2605e5f
Added path to toc file
karthikasf4617 509e11a
Addressed the review concerns
Manikandan-Kannan-1312 c1e2ec0
Merge pull request #3721 from syncfusion-content/IsReadOnlyUGDev
naveenkumar-sanjeevirayan 44b1468
Merge pull request #3719 from syncfusion-content/SelectAllOnFocusUGDev
naveenkumar-sanjeevirayan 8f60e3c
updated the images
SriRadheshNagS 9baafa0
updated the images
SriRadheshNagS aaa0565
Updated the images
karthikasf4617 cd041c8
Updated the images
SriRadheshNagS a9100c7
Update month-view.md
SriRadheshNagS a705294
Merge pull request #3737 from syncfusion-content/Vol3images
saiganesh-sakthivel aaf27cc
Added the release notes MD file and corresponding node entry in the T…
DeepakRajSundar 811540c
UG 986605: Updated the UG for TabView control new features [Development]
BrundhaVelusamy 2b7fbdf
Addressed the casing changes
Manikandan-Kannan-1312 0bcf21f
Merge pull request #3731 from syncfusion-content/selecteddropdownitem…
naveenkumar-sanjeevirayan 40ddfcf
Removed the Themes/Keys.md changes
BrundhaVelusamy ca8a0df
Merge pull request #3740 from syncfusion-content/TabView_UG_Dev
naveenkumar-sanjeevirayan 74ad472
982118 - UG Documentation for the MilliSecond Feature Updating the Im…
AravindSubramaniyan 0b20ca9
Merge pull request #3741 from syncfusion-content/982118-MilliSecondImage
MuniappanSubramanian 0576778
Merge pull request #3735 from syncfusion-content/ContextUG
FarjanaParveen c1c35fa
AI Coding Assistant UG for MAUI committed.
jayaleshwari 276eac2
Merge branch 'master' of https://github.com/syncfusion-content/maui-d…
jayaleshwari 66d11e4
Merge branch 'master' of https://github.com/syncfusion-content/maui-d…
jayaleshwari File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| --- | ||
| layout: post | ||
| title: SyncfusionMAUIAssistant MCP Server | Syncfusion | ||
| description: Learn how to configure and use SyncfusionMAUIAssistant MCP server for intelligent code generation, documentation, and troubleshooting in .NET MAUI apps. | ||
| platform: MAUI | ||
| control: Getting started with SyncfusionMAUIAssistant MCP Server | ||
| documentation: ug | ||
| --- | ||
|
|
||
| # SyncfusionMAUIAssistant MCP Server | ||
|
|
||
| ## Overview | ||
|
|
||
| The `SyncfusionMAUIAssistant` is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides intelligent assistance for developers using Syncfusion's .NET MAUI component libraries. This tool seamlessly integrates with compatible [MCP clients](https://modelcontextprotocol.io/clients) to enhance your development workflow when building .NET MAUI applications with Syncfusion<sup style="font-size:70%">®</sup> components. | ||
|
|
||
| ### Key Benefits | ||
|
|
||
| * Intelligent code generation for Syncfusion<sup style="font-size:70%">®</sup> .NET MAUI components. | ||
| * Detailed component documentation and usage examples. | ||
| * Troubleshooting assistance for common integration challenges. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before using `SyncfusionMAUIAssistant`, ensure you have: | ||
|
|
||
| * Required [node](https://nodejs.org/en/) version >= 18 | ||
| * A [compatible MCP client](https://modelcontextprotocol.io/clients) (VS Code with GitHub Copilot, [Syncfusion<sup style="font-size:70%">®</sup> CodeStudio](https://www.syncfusion.com/code-studio/), etc.) | ||
| * An active Syncfusion<sup style="font-size:70%">®</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) | ||
| * An active [API KEY](https://syncfusion.com/account/api-key) | ||
|
|
||
| ## Unlimited Access | ||
|
|
||
| Syncfusion<sup style="font-size:70%">®</sup> offers unlimited access to this MCP server. There are no restrictions on: | ||
|
|
||
| * Number of requests | ||
| * Components usage | ||
| * Query types | ||
| * Usage duration | ||
|
|
||
| This ensures users can fully leverage Syncfusion<sup style="font-size:70%">®</sup> components to enhance their development experience without limitations. | ||
|
|
||
| ## Installation and setup | ||
|
|
||
| Before you can invoke the `SyncfusionMAUIAssistant` MCP server, you need to configure your MCP client with these core settings. The **Generic MCP Server Settings** shown below are identical across all clients: | ||
|
|
||
| ### Generic MCP Server Settings | ||
|
|
||
| - **npm package name**: `@syncfusion/maui-assistant` | ||
| - **Type**: stdio (standard input/output transport) | ||
| - **Command**: npx | ||
| - **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: | ||
|
|
||
| ```json | ||
| "env": { | ||
| "Syncfusion_API_Key": "YOUR_API_KEY" | ||
| } | ||
| ``` | ||
|
|
||
| `SyncfusionMAUIAssistant` can be configured in various MCP clients. Below are setup instructions for popular environment: | ||
|
|
||
| ### Syncfusion<sup style="font-size:70%">®</sup> Code Studio | ||
|
|
||
| * In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace, find `SyncfusionMAUIAssistant`, and click Install. | ||
| * When prompted, enter your [Syncfusion API key](https://syncfusion.com/account/api-key) and click Submit to register. | ||
| * It installs locally on your machine and appears in the Installed list. | ||
| * The server is ready for use in Code Studio. | ||
|
|
||
| For additional details, see the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/marketplace). | ||
|
|
||
| ### VS Code (GitHub Copilot MCP) | ||
|
|
||
| 1. To configure an MCP server for a specific workspace, you can create a `.vscode/mcp.json` file in your workspace folder. | ||
|
|
||
| ```json | ||
| { | ||
| "servers": { | ||
| "syncfusion-maui-assistant": { | ||
| "type": "stdio", | ||
| "command": "npx", | ||
| "args": [ | ||
| "-y", | ||
| "@syncfusion/maui-assistant@latest" | ||
| ], | ||
| "env": { | ||
| "Syncfusion_API_Key": "YOUR_API_KEY" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 2. After updating the configuration in settings.json, you'll notice a "Start" option at the top of the config. This allows you to easily start the `SyncfusionMAUIAssistant` server directly from the settings interface without additional commands. | ||
|
|
||
| 3. Confirm that `SyncfusionMAUIAssistant` is being used (this does not happen automatically). Look for a statement in the output, which is similar to: | ||
| * `SyncfusionMAUIAssistant is running...` (in VS Code) | ||
|
|
||
| ### Cursor | ||
|
|
||
| To configure an MCP server for a specific workspace, you can create a .cursor/mcp.json file in your workspace folder. | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "syncfusion-maui-assistant": { | ||
| "type": "stdio", | ||
| "command": "npx", | ||
| "args": [ | ||
| "-y", | ||
| "@syncfusion/maui-assistant@latest" | ||
| ], | ||
| "env": { | ||
| "Syncfusion_API_Key": "YOUR_API_KEY" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### JetBrains IDEs | ||
|
|
||
| 1. Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP). | ||
| 2. Click + Add to add a new MCP server configuration. | ||
| 3. In the New MCP Server dialog, switch the dropdown as `As JSON` and add the following config: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "syncfusion-maui-assistant": { | ||
| "command": "npx", | ||
| "args": [ | ||
| "-y", | ||
| "@syncfusion/maui-assistant@latest" | ||
| ], | ||
| "env": { | ||
| "Syncfusion_API_Key": "YOUR_API_KEY" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 4. Click OK and Apply. | ||
|
|
||
| > For more detailed information about configuring MCP servers in various clients, refer to the official documentations. | ||
| * [VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server) | ||
| * [Cursor](https://cursor.com/docs/context/mcp#using-mcp-json) | ||
| * [JetBrains](https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server) | ||
| * [Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json) | ||
|
|
||
| ## Usage | ||
|
|
||
| To activate the SyncfusionMAUIAssistant MCP server: | ||
|
|
||
| 1. Start your prompt with one of the following: | ||
| * 'SyncfusionMAUIAssistant' | ||
| * '/syncfusion-maui-assistant' | ||
| * '/syncfusion-maui' | ||
| * '@syncfusion-maui' | ||
| * '@ask_syncfusion_maui' | ||
| * 'maui' | ||
|
|
||
| In VS Code, you can also use #SyncfusionMAUIAssistant to explicitly invoke the MCP server. | ||
|
|
||
| 2. Grant the SyncfusionMAUIAssistant MCP server a permission to run for this session, workspace, or always. | ||
| 3. For best results, start a new chat for each new topic to maintain clean context. | ||
|
|
||
| ### Mode availability | ||
|
|
||
| Syncfusion<sup style="font-size:70%">®</sup> MCP Servers provide full access to all AI interaction modes — Ask/Chat, Edit, and Agent — across supported MCP clients. | ||
|
|
||
| ### Best Practices for Effective Usage | ||
|
|
||
| 1. `Be specific`: Mention both platform and component (e.g., "How do I create a Syncfusion MAUI DataGrid with paging and filtering?"). | ||
| 2. `Provide context`: Include details about your use case for more targeted solutions. | ||
| 3. `Use descriptive queries`: Avoid vague questions that lack necessary context. | ||
| 4. `Start fresh for new topics`: Begin a new chat session when switching components or topics. | ||
|
|
||
| ### Example Queries | ||
|
|
||
| Here are some effective ways to use `SyncfusionMAUIAssistant`: | ||
|
|
||
| * "Create a Syncfusion .NET MAUI DataGrid component with paging, sorting and filtering" | ||
| * "How do I implement data binding with Syncfusion .NET MAUI Scheduler?" | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| If you encounter issues: | ||
|
|
||
| * Verify your API key is correctly configured. | ||
| * Ensure the MCP server is enabled in your client's tools selection. | ||
| * Check that you're using a compatible MCP client version. | ||
| * Try restarting your development environment. | ||
|
|
||
| ## Support | ||
|
|
||
| Product support is available through the following mediums. | ||
|
|
||
| * [Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours \| Unlimited tickets \| Holiday support | ||
| * [Community forum](https://www.syncfusion.com/forums/maui) | ||
| * [Request feature or report bug](https://www.syncfusion.com/feedback/maui) | ||
| * Live chat | ||
|
|
||
| ## See also | ||
|
|
||
| * [Syncfusion .NET MAUI Documentation](https://help.syncfusion.com/maui/introduction/overview) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| --- | ||
| layout: post | ||
| title: Syncfusion AI Coding Assistants Overview | Syncfusion | ||
| description: Learn how Syncfusion AI Coding Assistants boost .NET MAUI productivity by generating accurate code snippets, configuration examples, and contextual guidance. | ||
| platform: MAUI | ||
| control: Syncfusion AI Coding Assistants Overview | ||
| documentation: ug | ||
| --- | ||
|
|
||
| # Syncfusion® AI Coding Assistants Overview | ||
|
|
||
| The **Syncfusion<sup style="font-size:70%">®</sup> AI Coding Assistants** are designed to streamline your development workflow when building MAUI applications with Syncfusion<sup style="font-size:70%">®</sup> components. It uses contextual knowledge of the Syncfusion<sup style="font-size:70%">®</sup> component library to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity. | ||
|
|
||
| AI Coding Assistants: | ||
|
|
||
| * **The SyncfusionMAUIAssistant MCP Server** | ||
| Processes advanced prompts and returns tailored code suggestions via [MCP-compatible clients](https://modelcontextprotocol.io/clients). | ||
| * **SyncfusionMAUI GitHub Copilot Extension** | ||
| Augments GitHub Copilot with Syncfusion-specific support for rapid component setup and contextual guidance in the IDE. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| To use the AI Coding Assistants, you need: | ||
|
|
||
| * A [Syncfusion<sup style="font-size:70%">®</sup> user account](https://www.syncfusion.com/account) | ||
| * An active Syncfusion<sup style="font-size:70%">®</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) | ||
| * An active [API KEY](https://syncfusion.com/account/api-key) | ||
| * A [MAUI application that includes Syncfusion MAUI](https://help.syncfusion.com/maui/introduction/overview) | ||
|
|
||
| ## Unlimited Access | ||
|
|
||
| Syncfusion<sup style="font-size:70%">®</sup> offers unlimited access to the AI Coding Assistants, with no limitations on: | ||
|
|
||
| * Number of requests | ||
| * Components usage | ||
| * Query types | ||
| * Usage duration | ||
|
|
||
| This ensures users can fully leverage Syncfusion<sup style="font-size:70%">®</sup> components to enhance their development experience without limitations. | ||
|
|
||
| ## Best Practices | ||
|
|
||
| * Initial Setup: Use the tools to quickly add and configure Syncfusion<sup style="font-size:70%">®</sup> components in your MAUI application. | ||
| * Feature Tuning: Enable or disable component features through prompt-based configuration for tailored functionality. | ||
| * Data Binding: Generate sample data for testing and prototyping. Avoid using sensitive or production data to ensure security. | ||
| * Step-by-step explanations: Use annotated code to understand component behavior. Note that the level of detail may vary depending on the tool, mode, and AI model used. Refer to the [Syncfusion<sup style="font-size:70%">®</sup> MAUI Documentation](https://help.syncfusion.com/maui/introduction/overview) for in-depth information. | ||
| * Troubleshooting: Resolve common issues with AI-generated suggestions. For complex problems, refer to [documentation](https://help.syncfusion.com/maui/introduction/overview) or [support](https://support.syncfusion.com/support/tickets/create). | ||
|
|
||
| > Always check AI-generated content and code for accuracy before using it. | ||
|
|
||
| ## Recommendations | ||
|
|
||
| * Session Management: Start new sessions when switching tasks to ensure prompt relevance and maintain content focus. | ||
| * Model Compatibility: For optimal performance, use the tools with advanced AI models such as GPT-5 or Claude Sonnet 4. | ||
|
|
||
| ## Privacy & Data Handling | ||
|
|
||
| The Syncfusion<sup style="font-size:70%">®</sup> AI Coding Assistants is designed with privacy in mind: | ||
|
|
||
| * The tools do not access your project files or workspace directly. | ||
| * User prompts are not stored by any of the tools or used for any other purpose. | ||
| * Prompts are not used to train Syncfusion<sup style="font-size:70%">®</sup> models. | ||
| * The assistant generates context, while the final output is handled by your selected AI model. | ||
|
|
||
| ## See also | ||
|
|
||
| * Add the [SyncfusionMAUI MCP Server](./mcp-server.md) to an MCP-enabled client | ||
| * Install the [SyncfusionMAUI GitHub Copilot Extension](./copilot-extension.md) | ||
| * [Syncfusion<sup style="font-size:70%">®</sup> MAUI Documentation](https://help.syncfusion.com/maui/introduction) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -550,6 +550,44 @@ SfComboBox comboBox = new SfComboBox() | |||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### Customize the Selected DropDown Item Text Style | ||||||
|
|
||||||
| The [SelectedDropDownItemTextStyle]() property in the SfComboBox control allows developers to customize the appearance of the selected item in the dropdown list. This feature is useful for highlighting user selections and improving the overall UI experience. | ||||||
|
||||||
| The [SelectedDropDownItemTextStyle]() property in the SfComboBox control allows developers to customize the appearance of the selected item in the dropdown list. This feature is useful for highlighting user selections and improving the overall UI experience. | |
| The [SelectedDropDownItemTextStyle](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.Inputs.SfComboBox.html#Syncfusion_Maui_Inputs_SfComboBox_SelectedDropDownItemTextStyle) property in the SfComboBox control allows developers to customize the appearance of the selected item in the dropdown list. This feature is useful for highlighting user selections and improving the overall UI experience. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The property reference link is empty. Add the appropriate API documentation URL for the SelectedDropDownItemTextStyle property.