home / mcp / sugarcrm mcp server

SugarCRM MCP Server

Provides read-only access to Sugar CRM data via MCP for live querying by AI clients.

Installation
Add the following to your MCP client configuration file.

Configuration

View docs
{
  "mcpServers": {
    "cdatasoftware-sugar-crm-mcp-server-by-cdata": {
      "command": "java",
      "args": [
        "-jar",
        "/PATH/TO/CDataMCP-jar-with-dependencies.jar",
        "/PATH/TO/sugar-crm.prp"
      ]
    }
  }
}

This MCP server lets you query live Sugar CRM data through a simple MCP interface. It wraps the CData JDBC Driver so you can ask natural language questions and retrieve up-to-date CRM information without writing SQL. It provides a read-only bridge ideal for LLMs to access Sugar CRM data locally.

How to use

You connect to the Sugar CRM MCP Server from your MCP client (for example Claude Desktop) and then ask questions about your Sugar CRM data. The server exposes read-only access to your Sugar CRM tables and columns, letting you request data such as opportunities, accounts, tickets, or events. You do not need to write SQL; simply request the information in natural language and the client will route your query through the MCP server.

The MCP server provides tools that list available tables and columns, and to run queries. You can use these tools implicitly by asking the client to read data, or explicitly invoke a tool to discover the schema before asking for specific results.

How to install

# Prerequisites
# - Java Runtime Environment (JRE) or JDK
# - Maven for building the MCP server
# - The CData JDBC Driver for Sugar CRM (licensed or trial)

# 1) Build the MCP server
mvn clean install

# This creates the JAR file: CDataMCP-jar-with-dependencies.jar

# 2) Install the CData JDBC Driver for Sugar CRM
# Follow the driver's installer steps from the CData site and license the driver when prompted
# The license step will be performed from the DRIVER installation, not within this MCP server

# 3) License the CData JDBC Driver (example paths shown; use your actual install path)
# Windows
# java -jar cdata.jdbc.sugarcrm.jar --license
# Enter your name, email, and "TRIAL" (or your license key).
# Mac/Linux
# java -jar cdata.jdbc.sugarcrm.jar --license

# 4) Configure the connection to Sugar CRM
# Run the connection string utility to generate a connection string
java -jar cdata.jdbc.sugarcrm.jar
# Test Connection in the utility and copy the connection string for use below

# 5) Create a .prp file for the JDBC connection
# Example sugar-crm.prp
Prefix=sugarcrm
ServerName=CDataSugarCRM
ServerVersion=1.0
DriverPath=PATH\\TO\\cdata.jdbc.sugarcrm.jar
DriverClass=cdata.jdbc.sugarcrm.SugarCRMDriver
JdbcUrl=jdbc:sugarcrm:InitiateOAuth=GETANDREFRESH;
Tables=

Additional configuration and usage notes

The MCP server is run as a local process and communicates with clients on the same machine. You provide the path to the sugar-crm.prp file to specify the JDBC connection details and data you want to expose.

Troubleshooting and tips

If you cannot see your MCP Server in your client, ensure the server process is started and the client is fully restarted so it reloads available MCP servers.

Tools & capabilities

The server exposes the following tools for querying Sugar CRM data:

- sugarcrm_get_tables — Retrieves a list of tables available in the data source. Output is in CSV with column headers on the first line.

- sugarcrm_get_columns — Retrieves a list of columns for a specified table. Output is in CSV with column headers on the first line.

- sugarcrm_run_query — Executes a SQL SELECT query against Sugar CRM data.

JSON-RPC Request Examples

Use these patterns if you are scripting requests to the MCP Server. The server supports standard JSON-RPC 2.0 calls to its tools.

Available tools

sugarcrm_get_tables

Retrieves a list of tables available in the data source. Output is in CSV format with the first line containing column headers.

sugarcrm_get_columns

Retrieves a list of columns for a specified table. Output is in CSV format with the first line containing column headers.

sugarcrm_run_query

Executes a SQL SELECT query against the Sugar CRM data source and returns results.