CData SuiteCRM Server

A read-only MCP server for querying live SuiteCRM data using the CData JDBC Driver.

CData's Model Context Protocol (MCP) Server for SuiteCRM

:heavy_exclamation_mark: This project builds a read-only MCP server. For full read, write, update, delete, and action capabilities and a simplified setup, check out ourCData MCP Server for SuiteCRM.

We created this read-only MCP Server to allow LLMs (like Claude Desktop) to query live data SuiteCRM supported by theCData JDBC Driver for SuiteCRM.

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

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=

{ "mcpServers": { "{classname_dash}": { "command": "PATH\\TO\\java.exe", "args": [ "-jar", "PATH\\TO\\CDataMCP-jar-with-dependencies.jar", "PATH\\TO\\suitecrm.prp" ] }, ... } }

{ "mcpServers": { "{classname_dash}": { "command": "/PATH/TO/java", "args": [ "-jar", "/PATH/TO/CDataMCP-jar-with-dependencies.jar", "/PATH/TO/suitecrm.prp" ] }, ... } }

If needed, copy the config file to the appropriate directory (Claude Desktop as the example).Windows

cp C:\PATH\TO\claude_desktop_config.json %APPDATA%\Claude\claude_desktop_config.json

cp /PATH/TO/claude_desktop_config.json /Users/{user}/Library/Application\ Support/Claude/claude_desktop_config.json'

Run or refresh your client (Claude Desktop).

Note:You may need to fully exit or quit your Claude Desktop client and re-open it for the MCP Servers to appear.
- Run the follow the command to run the MCP Server on its own

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

Note:The server usesstdioso can only be used with clients that run on the same machine as the server.

Once the MCP Server is configured, the AI client will be able to use the built-in tools to read, write, update, and delete the underlying data. In general, you do not need to call the tools explicitly. Simply ask the client to answer questions about the underlying data system. For example:

- "What is the correlation between my closed won opportunities and the account industry?"
- "How many open tickets do I have in the SUPPORT project?"
- "Can you tell me what calendar events I have today?"

The list of tools available and their descriptions follow:

In the definitions below,{servername}refers to the name of the MCP Server in the config file (e.g.{classname_dash}above).

- {servername}_get_tables- Retrieves a list of tables available in the data source. Use the{servername}_get_columnstool to list available columns on a table. The output of the tool will be returned in CSV format, with the first line containing column headers.
- {servername}_get_columns- Retrieves a list of columns for a table. Use the{servername}_get_tablestool to get a list of available tables. The output of the tool will be returned in CSV format, with the first line containing column headers.
- {servername}_run_query- Execute a SQL SELECT query

If you are scripting out the requests sent to the MCP Server instead of using an AI Client (e.g. Claude), then you can refer to the JSON payload examples below – following the JSON-RPC 2.0 specification - when calling the available tools.

{ "jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": { "name": "source_get_tables", "arguments": {} } }

{ "jsonrpc": "2.0", "id": 2, "method": "tools/call", "params": { "name": "source_get_columns", "arguments": { "table": "Account" } } }

{ "jsonrpc": "2.0", "id": 3, "method": "tools/call", "params": { "name": "source_run_query", "arguments": { "sql": "SELECT * FROM [Account] WHERE [IsDeleted] = true" } } }

- If you cannot see your CData MCP Server in Claude Desktop, be sure that you have fully quit Claude Desktop (Windows: use the Task Manager, Mac: use the Activity Monitor)
- If Claude Desktop is unable to retrieve data, be sure that you have configured your connection properly. Use the Connection String builder to create the connection string (see above) and copy the connection string into the property (.prp) file.
- If you are having trouble connecting to your data source, contact theCData Support Team.
- If you are having trouble using the MCP server, or have any other feedback, join theCData Community.

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see theLICENSEfile in the project repository.

Kash.click management assistant. Connect your assistant to your business complete sales history, clients, payments, tax information, employees, points of sales.