sap-netweaver-gateway-mcp-server-by-cdata

CData's Model Context Protocol (MCP) Server for SAP Netweaver Gateway

: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 our CData MCP Server for SAP Netweaver Gateway.

Purpose

We created this read-only MCP Server to allow LLMs (like Claude Desktop) to query live data SAP Netweaver Gateway supported by the CData JDBC Driver for SAP Netweaver Gateway.

CData JDBC Driver connects to SAP Netweaver Gateway by exposing them as relational SQL models.

This server wraps that driver and makes SAP Netweaver Gateway data available through a simple MCP interface, so LLMs can retrieve live information by asking natural language questions — no SQL required.

Setup Guide

1. Clone the repository:

   git clone https://github.com/cdatasoftware/sap-netweaver-gateway-mcp-server-by-cdata.git
   cd sap-netweaver-gateway-mcp-server-by-cdata
   

2. Build the server:

   mvn clean install
   

   This creates the JAR file: CDataMCP-jar-with-dependencies.jar
3. Download and install the CData JDBC Driver for {source}: https://www.cdata.com/drivers/sapgateway/download/jdbc
4. License the CData JDBC Driver:
   • Navigate to the lib folder in the installation directory, typically:
     • (Windows) C:\Program Files\CData\CData JDBC Driver for SAP Netweaver Gateway\
     • (Mac/Linux) /Applications/CData JDBC Driver for SAP Netweaver Gateway/
   • Run the command java -jar cdata.jdbc.sapgateway.jar --license
   • Enter your name, email, and "TRIAL" (or your license key).
5. Configure your connection to the data source (Salesforce as an example):

   • Run the command java -jar cdata.jdbc.sapgateway.jar to open the Connection String utility.

     

   • Configure the connection string and click "Test Connection"

     Note: If the data sources uses OAuth, you will need to authenticate in your browser.

   • Once successful, copy the connection string for use later.

6. Create a .prp file for your JDBC connection (e.g. sap-netweaver-gateway.prp) using the following properties and format:
   • Prefix - a prefix to be used for the tools exposed
   • ServerName - a name for your server
   • ServerVersion - a version for your server
   • DriverPath - the full path to the JAR file for your JDBC driver
   • DriverClass - the name of the JDBC Driver Class (e.g. cdata.jdbc.sapgateway.SAPGatewayDriver)
   • JdbcUrl - the JDBC connection string to use with the CData JDBC Driver to connect to your data (copied from above)
   • Tables - leave blank to access all data, otherwise you can explicitly declare the tables you wish to create access for

     Prefix=sapgateway
     ServerName=CDataSAPGateway
     ServerVersion=1.0
     DriverPath=PATH\TO\cdata.jdbc.sapgateway.jar
     DriverClass=cdata.jdbc.sapgateway.SAPGatewayDriver
     JdbcUrl=jdbc:sapgateway:InitiateOAuth=GETANDREFRESH;
     Tables=
     

Using the Server with Claude Desktop

1. Create the config file for Claude Desktop ( claude_desktop_config.json) to add the new MCP server, using the format below. If the file already exists, add the entry to the mcpServers in the config file.

   Windows

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

   Linux/Mac

   {
     "mcpServers": {
       "{classname_dash}": {
         "command": "/PATH/TO/java",
         "args": [
           "-jar",
           "/PATH/TO/CDataMCP-jar-with-dependencies.jar",
           "/PATH/TO/sap-netweaver-gateway.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
   

   Linux/Mac

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

2. 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.

Running the Server

1. 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 uses stdio so can only be used with clients that run on the same machine as the server.

Usage Details

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:

Tools & Descriptions

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_columns tool 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_tables tool 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

JSON-RPC Request Examples

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.

source_get_tables

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

source_get_columns

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

source_run_query

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

Troubleshooting

1. 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)
2. 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.
3. If you are having trouble connecting to your data source, contact the CData Support Team.
4. If you are having trouble using the MCP server, or have any other feedback, join the CData Community.

License

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 the LICENSE file in the project repository.

All Supported Sources

Access	Act CRM	Act-On	Active Directory
ActiveCampaign	Acumatica	Adobe Analytics	Adobe Commerce
ADP	Airtable	AlloyDB	Amazon Athena
Amazon DynamoDB	Amazon Marketplace	Amazon S3	Asana
Authorize.Net	Avalara AvaTax	Avro	Azure Active Directory
Azure Analysis Services	Azure Data Catalog	Azure Data Lake Storage	Azure DevOps
Azure Synapse	Azure Table	Basecamp	BigCommerce
BigQuery	Bing Ads	Bing Search	Bitbucket
Blackbaud FE NXT	Box	Bullhorn CRM	Cassandra
Certinia	Cloudant	CockroachDB	Confluence
Cosmos DB	Couchbase	CouchDB	CSV
Cvent	Databricks	DB2	DocuSign
Dropbox	Dynamics 365	Dynamics 365 Business Central	Dynamics CRM
Dynamics GP	Dynamics NAV	eBay	eBay Analytics
Elasticsearch	Email	EnterpriseDB	Epicor Kinetic
Exact Online	Excel	Excel Online	Facebook
Facebook Ads	FHIR	Freshdesk	FTP
GitHub	Gmail	Google Ad Manager	Google Ads
Google Analytics	Google Calendar	Google Campaign Manager 360	Google Cloud Storage
Google Contacts	Google Data Catalog	Google Directory	Google Drive
Google Search	Google Sheets	Google Spanner	GraphQL
Greenhouse	Greenplum	HarperDB	HBase
HCL Domino	HDFS	Highrise	Hive
HubDB	HubSpot	IBM Cloud Data Engine	IBM Cloud Object Storage
IBM Informix	Impala	Instagram	JDBC-ODBC Bridge
Jira	Jira Assets	Jira Service Management	JSON
Kafka	Kintone	LDAP	LinkedIn
LinkedIn Ads	MailChimp	MariaDB	Marketo
MarkLogic	Microsoft Dataverse	Microsoft Entra ID	Microsoft Exchange
Microsoft OneDrive	Microsoft Planner	Microsoft Project	Microsoft Teams
Monday.com	MongoDB	MYOB AccountRight	MySQL
nCino	Neo4J	NetSuite	OData
Odoo	Office 365	Okta	OneNote
Oracle	Oracle Eloqua	Oracle Financials Cloud	Oracle HCM Cloud
Oracle Sales	Oracle SCM	Oracle Service Cloud	Outreach.io
Parquet	Paylocity	PayPal	Phoenix
PingOne	Pinterest	Pipedrive	PostgreSQL
Power BI XMLA	Presto	Quickbase	QuickBooks
QuickBooks Online	QuickBooks Time	Raisers Edge NXT	Reckon
Reckon Accounts Hosted	Redis	Redshift	REST
RSS	Sage 200	Sage 300	Sage 50 UK
Sage Cloud Accounting	Sage Intacct	Salesforce	Salesforce Data Cloud
Salesforce Financial Service Cloud	Salesforce Marketing	Salesforce Marketing Cloud Account Engagement	Salesforce Pardot
Salesloft	SAP	SAP Ariba Procurement	SAP Ariba Source
SAP Business One	SAP BusinessObjects BI	SAP ByDesign	SAP Concur
SAP Fieldglass	SAP HANA	SAP HANA XS Advanced	SAP Hybris C4C
SAP Netweaver Gateway	SAP SuccessFactors	SAS Data Sets	SAS xpt
SendGrid	ServiceNow	SFTP	SharePoint
SharePoint Excel Services	ShipStation	Shopify	SingleStore
Slack	Smartsheet	Snapchat Ads	Snowflake
Spark	Splunk	SQL Analysis Services	SQL Server
Square	Stripe	Sugar CRM	SuiteCRM
SurveyMonkey	Sybase	Sybase IQ	Tableau CRM Analytics
Tally	TaxJar	Teradata	Tier1
TigerGraph	Trello	Trino	Twilio
Twitter	Twitter Ads	Veeva CRM	Veeva Vault
Wave Financial	WooCommerce	WordPress	Workday
xBase	Xero	XML	YouTube Analytics
Zendesk	Zoho Books	Zoho Creator	Zoho CRM
Zoho Inventory	Zoho Projects	Zuora	... Dozens More