Sap Netweaver Gateway MCP Server By Cdata

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

CData's Model Context Protocol (MCP) Server for SAP Netweaver Gateway enables seamless data access for LLMs.

⚠️ Important Note

This project builds a read-only MCP server. For full read, write, update, delete, and action capabilities and a simplified setup, check out our free CData MCP Server for SAP Netweaver Gateway (beta).

🚀 Quick Start

This read-only MCP Server allows LLMs (like Claude Desktop) to query live data from SAP Netweaver Gateway via the CData JDBC Driver for SAP Netweaver Gateway. The CData JDBC Driver exposes SAP Netweaver Gateway data as relational SQL models, and this server wraps the driver, providing a simple MCP interface for LLMs to retrieve information using natural language.

✨ Features

• Enables LLMs to query live data from SAP Netweaver Gateway.
• Uses the CData JDBC Driver to expose data as relational SQL models.
• Provides a simple MCP interface for natural language queries.

📦 Installation

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

   ⚠️ Important 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=sapgateway
   ServerName=CDataSAPGateway
   ServerVersion=1.0
   DriverPath=PATH\TO\cdata.jdbc.sapgateway.jar
   DriverClass=cdata.jdbc.sapgateway.SAPGatewayDriver
   JdbcUrl=jdbc:sapgateway:InitiateOAuth=GETANDREFRESH;
   Tables=
   

💻 Usage Examples

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

⚠️ Important 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

Run the following command to run the MCP Server on its own:

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

⚠️ Important 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 can use the built-in tools to read, write, update, and delete the underlying data. Generally, you don't 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:

• {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"
        }
    }
}

📚 Documentation

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