diff --git a/MAUI/AI-Coding-Assistants/mcp-server.md b/MAUI/AI-Coding-Assistants/mcp-server.md new file mode 100644 index 000000000..c0a310899 --- /dev/null +++ b/MAUI/AI-Coding-Assistants/mcp-server.md @@ -0,0 +1,236 @@ +--- +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® components. + +### Key Benefits + +* Intelligent code generation for Syncfusion® .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® CodeStudio](https://www.syncfusion.com/code-studio/), etc.) +* An active Syncfusion® 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® 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® 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" +} +``` + +Below are setup instructions for popular MCP clients: + +### Syncfusion® Code Studio + +* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the `Custom Servers` tab. +* Enter the Server Name as `maui-mcp`, choose Server Type as npm package, and set the NPM Package name to `@syncfusion/maui-assistant`. +* Add an environment variable as `Syncfusion_API_Key` and value as your [Syncfusion API key](https://syncfusion.com/account/api-key), then click **Install Server**. +* Once installed, the server will appear in the User Installed Server list, and will be added to the **config.yaml** file. +* The server is now ready for use in Code Studio. For more details, refer to the [Code Studio documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers#npm-server). + +### Visual Studio Code (GitHub Copilot MCP) + +* 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" + } + } + } +} +``` + +* 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. + +* Confirm the server is active by checking for a message like: `SyncfusionMAUIAssistant is running...` in the output. + +* For additional guidance, refer to the [VS Code documentation](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_add-an-mcp-server). + +### Visual Studio (GitHub Copilot MCP) + +* To configure an MCP server for a specific workspace, you can create a `.vs/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" + } + } + } +} +``` + +* After updating the mcp.json configuration, open the GitHub Copilot Chat window. Click the Ask arrow, then select Agent. +* Select the `SyncfusionMAUIAssistant`from the tools section. +* For more details, refer to the official [Visual Studio documentation](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022). + +### 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" + } + } + } +} +``` +For more details, refer to the [Cursor documentation](https://cursor.com/docs/context/mcp#using-mcp-json). + +### JetBrains IDEs + +* Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP). +* Click + Add to add a new MCP server configuration. +* 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" + } + } + } +} +``` + +* Click OK and Apply. + +For further assistance, see the [JetBrains documentation](https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server). + +> For more detailed information about configuring MCP servers in various clients, refer to the official documentations, e.g., [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 for direct invocation. + +2. Grant permission for the server to run (for the session, workspace, or always). +3. For best results, start a new chat for each new topic to maintain clean context. + +### Mode availability + +Syncfusion® 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) diff --git a/MAUI/AI-Coding-Assistants/overview.md b/MAUI/AI-Coding-Assistants/overview.md new file mode 100644 index 000000000..11107ac10 --- /dev/null +++ b/MAUI/AI-Coding-Assistants/overview.md @@ -0,0 +1,70 @@ +--- +layout: post +title: Syncfusion AI Coding Assistant Overview | Syncfusion +description: Learn how Syncfusion AI Coding Assistant boost .NET MAUI productivity by generating accurate code snippets, configuration examples, and contextual guidance. +platform: MAUI +control: Syncfusion AI Coding Assistant Overview. +documentation: ug +--- + +# Syncfusion® AI Coding Assistant Overview + +The **Syncfusion® AI Coding Assistant** are designed to streamline your development workflow when building MAUI applications with Syncfusion® components. It uses contextual knowledge of the Syncfusion® component library to generate accurate code snippets, configuration examples, and guided explanations—minimizing documentation searches and maximizing productivity. + +AI Coding Assistant: + +* **The SyncfusionMAUIAssistant MCP Server** + Processes advanced prompts and returns tailored code suggestions via [MCP-compatible clients](https://modelcontextprotocol.io/clients). + + +## Getting Started + +To use the AI Coding Assistant, you need: + +* A [Syncfusion® user account](https://www.syncfusion.com/account) +* An active Syncfusion® 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® offers unlimited access to the AI Coding Assistant, with no limitations on: + +* Number of requests +* Components usage +* Query types +* Usage duration + +This ensures users can fully leverage Syncfusion® components to enhance their development experience without limitations. + +## Best Practices + +* Initial Setup: Use the tools to quickly add and configure Syncfusion® 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® 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® AI Coding Assistant 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® models. +* The assistant generates context, while the final output is handled by your selected AI model. + +## See also + +* Add the `SyncfusionMAUIAssistant MCP Server` to an MCP-enabled client +* [Syncfusion® MAUI Documentation](https://help.syncfusion.com/maui/introduction) diff --git a/maui-toc.html b/maui-toc.html index 651f4352a..a28783431 100644 --- a/maui-toc.html +++ b/maui-toc.html @@ -12,6 +12,12 @@
  • System Requirements
  • Demos
  • Material Icons
    • +
  • AI Coding Assistant + +
  • Installation