Build Sugar CRM-Powered Applications in GitHub Copilot with CData Code Assist MCP

GitHub Copilot is an AI-powered coding assistant that integrates directly into Visual Studio Code and other IDEs. With support for MCP, GitHub Copilot can connect to local tools and enterprise data sources, enabling natural language interaction with live systems during development.

Model Context Protocol (MCP) is an open standard for connecting LLM clients to external services through structured tool interfaces. MCP servers expose capabilities such as schema discovery and live querying, allowing AI agents to retrieve and reason over real-time data safely and consistently.

In this article, we guide you through installing the CData Code Assist MCP for Sugar, configuring the connection to Sugar CRM, connecting the Code Assist MCP add-on to GitHub Copilot, and querying live Sugar CRM data from within Visual Studio Code.

Prerequisites

• Visual Studio Code is installed on your machine
• GitHub Copilot Chat extension is enabled in Visual Studio Code
• CData Code Assist MCP for Sugar has been installed

Step 1: Download and install the CData Code Assist MCP for Sugar

1. To begin, download the CData Code Assist MCP for Sugar 👁 Downloading the CData Code Assist MCP add-on installer
   
2. Find and double-click the installer to begin the installation
3. Run the installer and follow the prompts to complete the installation 👁 Completing the CData Code Assist MCP add-on installation
   

When the installation is complete, you are ready to configure your Code Assist MCP add-on by connecting to Sugar CRM.

Step 2: Configure the connection to Sugar CRM

1. After installation, open the CData Code Assist MCP for Sugar configuration wizard 👁 The CData Code Assist MCP add-on configuration wizard
   

   NOTE: If the wizard does not open automatically, search for "CData Code Assist MCP for Sugar" in the Windows search bar and open the application.

   👁 Opening the CData Code Assist MCP add-on configuration wizard (Google Sheets is shown).
   
2. In MCP Configuration > Configuration Name, either select an existing configuration or choose to create a new one 👁 Creating a new configuration
   
3. Name the configuration (e.g. "cdata_sugarcrm") and click OK 👁 Naming the configuration
   

4. Enter the appropriate connection properties in the configuration wizard

   The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

   You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

   Additionally, specify the URL to the SugarCRM account.

   Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

   👁 Configuring the Code Assist MCP add-on connection
   
5. Click Connect to authenticate with Sugar CRM
6. Click Save & Test to finalize the connection 👁 Saving and testing the Code Assist MCP add-on configuration
   

This process creates a .mcp configuration file that GitHub Copilot will reference when launching the Code Assist MCP add-on. Now with your Code Assist MCP add-on configured, you are ready to connect it to GitHub Copilot.

Step 3: Connect the Code Assist MCP add-on to GitHub Copilot

1. Download and install Visual Studio Code and enable the GitHub Copilot Chat extension

Option 1: Manually add the MCP configuration

1. Open or create the mcp.json file:
   • For global configuration: %%APPDATA%%/Roaming/Code/User/mcp.json
   • For project-specific configuration:
2. Add the JSON code shown below and save the file

{
 "servers": {
 "cdata_sugarcrm": {
 "command": "C:\Program Files\CData\CData Code Assist MCP for Sugar\jre\bin\java.exe",
 "args": [
 "-Dfile.encoding=UTF-8",
 "-jar",
 "C:\Program Files\CData\CData Code Assist MCP for Sugar\lib\cdata.mcp.sugarcrm.jar",
 "cdata_sugarcrm"
 ]
 }
 }
}

NOTE: The command value should point to your Java 17+ java.exe executable, and the JAR path should point to the installed CData Code Assist MCP add-on .jar file. The final argument must match the MCP configuration name you saved in the CData configuration wizard (e.g. "cdata_sugarcrm").

Option 2: Copy the MCP configuration from the CData Code Assist MCP for Sugar UI

1. After saving and testing your connection in the configuration wizard, click Next 👁 Selecting 'Next'
   
2. Select Github Copilot from the AI MCP Tool dropdown 👁 Choosing GitHub Copilot as the AI MCP tool
   
3. Follow the MCP Client Instructions to create the required configuration file 👁 MCP configuration instructions for GitHub Copilot
   
4. Copy the displayed JSON code and paste it into your configuration file

Step 4: Query live Sugar CRM data in GitHub Copilot

1. Launch Visual Studio Code and open the GitHub Copilot Chat interface. Select the tool icon to enable the configured Code Assist MCP add-on 👁 Enabling the CData Code Assist MCP add-on in GitHub Copilot
   
2. Ask questions about your Sugar CRM data using natural language. For example:

   "List all tables available in my Sugar CRM data data connection."

   👁 Querying live data from GitHub Copilot
   
3. Start building with natural language prompts:

   For my project, data from the Accounts is very important. Pull data from the most important columns like Name and AnnualRevenue.
   

GitHub Copilot is now fully integrated with CData Code Assist MCP for Sugar and can use the MCP tools to explore schemas and execute live queries against Sugar CRM.

Build with Code Assist MCP. Deploy with CData Drivers.

Download Code Assist MCP for free and give your AI tools schema-aware access to live Sugar CRM data during development. When you're ready to move to production, CData Sugar CRM Drivers deliver the same SQL-based access with enterprise-grade performance, security, and reliability.

Visit the CData Community to share insights, ask questions, and explore what's possible with MCP-powered AI workflows.