suitecrm_get_tablesLABSCO SUMMARY
Read-only by construction.
Three tools and no write path is the whole design: the model discovers tables, reads columns and runs SELECTs, so a badly framed question produces a wrong answer rather than a changed record. Two things decide whether it fits. The CData JDBC driver is a separate licensed product, with a trial key to start on. And the assistant can query every table the connection can see — the Tables field in the connection profile does not narrow that, so limit the connection or the account it signs in with.
What it is
A read-only MCP server built on CData's JDBC Driver for SuiteCRM. The driver exposes SuiteCRM as relational tables; the server puts three tools over it, so a client can discover what tables exist, read a table's columns, and run a SELECT — without anyone writing SQL by hand.
What you get
- The tables the driver exposes for SuiteCRM, returned as CSV with a header row —
suitecrm_get_tables - The columns of one of those tables, also as CSV, so a query can be composed against real field names —
suitecrm_get_columns - A SQL SELECT executed against live SuiteCRM data —
suitecrm_run_query - Tool names that carry the prefix you set in the connection profile — the sample uses
Prefix=suitecrm— so several CData servers can run side by side without colliding - A
Tablessetting that only picks which tables also get a ready-made description (blank means none); it does not limit what the tools can list or query, so limit the connection or the account it signs in with
Requirements
Java and Maven to build — mvn clean install produces CDataMCP-jar-with-dependencies.jar. The CData JDBC Driver for SuiteCRM is a separate download and needs licensing: run java -jar cdata.jdbc.suitecrm.jar --license and enter a name, an email and either TRIAL or a licence key. Connection settings go in a .prp file carrying Prefix, ServerName (the sample uses CDataSuiteCRM), ServerVersion, DriverPath, DriverClass (cdata.jdbc.suitecrm.SuiteCRMDriver), the JdbcUrl produced by the driver's connection-string utility, and the optional Tables list. The client then launches java -jar CDataMCP-jar-with-dependencies.jar <YOUR_PRP_FILE>.prp. Transport is stdio, so the server has to run on the same machine as the client. If the data source authenticates over OAuth, you approve it in a browser while building the connection string.
Setup effort
Build from source — clone the repository, then point your client at the binary
USE CASES
01
Asking about the sales pipeline in plain language
Accounts, contacts, leads and opportunities arrive as tables, so a pipeline question becomes one SELECT.
02
Reporting across modules in a single query
Join related CRM records instead of exporting each module and reconciling the files.
03
Finding out which modules are exposed
List the tables the driver models and read a table's columns to see the fields available for reporting.
04
Keeping contact data scoped
Restrict the profile's table list so only the modules you intend are reachable by the model.
3 tools
Listed in project docs. Your client may show a different list.
suitecrm_get_columnssuitecrm_run_queryBEFORE YOU INSTALL
What to know first
Tools you get
3 tools named in the project's documentation. All tools are read-only; full read-write access is the separate paid CData MCP Server for SuiteCRM. Tool names start with the Prefix in the .prp file (suitecrm_ in the sample). The Tables setting does not limit what the tools reach; your connection's access does.
Where it runs
The documented client runs the server on your machine.
INSTALLATION
Connect your client
Clone the repository, then point your client at the binary. This one is built from source rather than installed with a single command.
Server setup
TERMINAL
git clone https://github.com/cdatasoftware/suitecrm-mcp-server-by-cdata.git
cd suitecrm-mcp-server-by-cdata
mvn clean installDownload and install the CData JDBC Driver for SuiteCRM from https://www.cdata.com/drivers/suitecrm/download/jdbc
License the driver: from the driver install's lib folder run java -jar cdata.jdbc.suitecrm.jar --license, then enter your name, email, and "TRIAL" (or your license key)
Build the connection string: run java -jar cdata.jdbc.suitecrm.jar to open the Connection String utility, click "Test Connection" (browser OAuth if the source needs it), and copy the connection string
Create suitecrm.prp with:
FILE · suitecrm.prp
Prefix=suitecrm
ServerName=CDataSuiteCRM
ServerVersion=1.0
DriverPath=<YOUR_DRIVER_PATH>
DriverClass=cdata.jdbc.suitecrm.SuiteCRMDriver
JdbcUrl=<YOUR_JDBC_URL>
Tables=Tables only picks which tables also get a ready-made description for your assistant, and empty means none; the server can still list and query every table your connection string reaches, so to keep data out of reach, limit that connection or the account it signs in with.
Add the mcpServers entry below to claude_desktop_config.json and restart the client
MCP Clients
Claude Desktop — macOS or Linux
CLAUDE DESKTOP — MACOS OR LINUX · JSON
{
"mcpServers": {
"suitecrm": {
"command": "<YOUR_PATH_TO_JAVA>",
"args": [
"-jar",
"<YOUR_PATH_TO_CDATA_MCP_JAR_WITH>",
"<YOUR_PATH_TO_SUITECRM>"
]
}
}
}