SuiteCRM

You provide a read-only MCP server that lets you query live SuiteCRM data through the CData JDBC Driver, enabling natural-language questions without writing SQL. This server exposes the data via the MCP interface so you can ask questions like opportunities by industry or ticket counts and receive up-to-date results from SuiteCRM.

How to use

You run the MCP server locally and connect your AI client to it. The server is designed to be used with clients that execute commands on the same machine, and it exposes tools to list available tables and columns, then run read-only queries. You will typically: start the local MCP process, configure your AI client to load this MCP server, and then ask natural-language questions about SuiteCRM data. The client will use the built-in tools to retrieve table and column information, and to execute read-only queries against your SuiteCRM data through the CData JDBC Driver.

How to install

Prerequisites you need before installing:

• Java Runtime Environment (JRE) or JDK to run the MCP server jar
• Maven to build the MCP server from source
• Internet access to download dependencies and the CData JDBC Driver for SuiteCRM
• A working SuiteCRM instance and a valid CData JDBC Driver license (or trial) if you plan to connect to live data.

git clone https://github.com/cdatasoftware/suitecrm-mcp-server-by-cdata.git
cd suitecrm-mcp-server-by-cdata

Build the MCP server to produce the runnable jar.

mvn clean install

Download and install the CData JDBC Driver for SuiteCRM from the driver page, then license the driver. This enables the MCP server to connect to SuiteCRM data.

# Example licensing step (adjust to your OS and installation path)
java -jar cdata.jdbc.suitecrm.jar --license

Configure your JDBC connection using the driver’s Connection String utility, then save the connection string to a .prp file. This file is used by the MCP server to connect to SuiteCRM.

# Example demonstration of creating a .prp file content
Prefix=suitecrm
ServerName=CDataSuiteCRM
ServerVersion=1.0
DriverPath=/path/to/cdata.jdbc.suitecrm.jar
DriverClass=cdata.jdbc.suitecrm.SuiteCRMDriver
JdbcUrl=jdbc:suitecrm:InitiateOAuth=GETANDREFRESH;
Tables=

Running the MCP server locally

Start the MCP server using the prepared .prp file. The server runs via a stdio-based interface, so you run it on the same machine as your AI client.

java -jar /PATH/TO/CDataMCP-jar-with-dependencies.jar /PATH/TO/suitecrm.prp

Using with an MCP client like Claude Desktop

Create a client configuration that points to the local MCP server. The client loads the MCP server by executing the Java process with the jar and your .prp file as arguments. If you need to switch or add servers, you can extend the client’s MCP configuration to include additional stdio entries.

Example Windows client configuration snippet (adjust paths to your environment):

{
  "mcpServers": {
    "suitecrm_mcp": {
      "command": "C:\\path\\to\\java.exe",
      "args": [
        "-jar",
        "C:\\path\\to\\CDataMCP-jar-with-dependencies.jar",
        "C:\\path\\to\\suitecrm.prp"
      ]
    }
  }
}

Notes about configuration and security

• The server is read-only by design, offering query capabilities without write, update, delete, or actions against the underlying data.
• Ensure your SuiteCRM data source is accessible from the machine running the MCP server.
• Keep the .prp file secure since it contains the JDBC connection string and may reference credentials or OAuth tokens.

Troubleshooting

If you cannot see the MCP server in your client, fully quit the client and restart it so it reloads the MCP configuration. If data cannot be retrieved, verify the connection string and ensure the JDBC driver is licensed and properly installed. If you encounter connection or configuration issues, contact CData Support or join the CData Community for guidance.

License

This MCP server is licensed under the MIT License. You may use, modify, and distribute the software in accordance with MIT terms.

Important example usage scenarios

Ask questions like:

• What is the correlation between closed won opportunities and account industry?
• How many open tickets exist in the SUPPORT project?
• Which calendar events do I have today?

Available tools

suitecrm_mcp_get_tables

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

suitecrm_mcp_get_columns

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

suitecrm_mcp_run_query

Executes a SQL SELECT query against the data source and returns the result set.