Setup

Setup

0. Prerequisites

• Node.js (https://nodejs.org)
• AI IDE with MCP support
• SAP system to connect to
• Windows 10+ x64
• linux/amd64, expected to work on modern glibc-based distributions as Ubuntu 22.04+, Debian 12+, RHEL/Rocky/Alma 9+

1. Setting Up Credentials

Before the bridge can orchestrate SAP tasks, you must generate your encrypted .sap_credentials. We provide a native interactive CLI wizard sap-setupto securely walk you through this (found in bin folder).

⚠️ SAP Credentials: You must launch the setup wizard strictly from the project's Root Directory. This ensures that the generated .sap_credentials file is anchored at the top-level scope correctly for the bridge to consume.

1. Open your terminal and navigate into the project's Root Directory.
2. Launch the compiled setup wizard:

   # Windows
   .\sap-setup.exe
   
   # macOS / Linux
   ./sap-setup

3. Follow the on-screen prompts to establish your SAP System connections (such as Host, Client, Scheme, and Port).
4. The wizard will write to .sap_credentials locally.

⚠️ Credential Placement: The bridge natively probes the Current Working Directory (CWD) for your .sap_credentials file. If you are registering this MCP Server globally in your system, ensure that the orchestrator executes the binary from the directory holding the credentials file.

Note: .sap_credentials is a JSON file, you can enable / disable system entries as well as defining a standard entry by editing this file manually.

2. Registering the Bridge

The sap-bridge operates natively as an orchestrator-agnostic MCP server, fully supporting modern AI IDEs and clients.

It uses standard process stdio pipelines to communicate with your AI securely and silently in the background.

To register the bridge into your orchestrator's MCP config file, assign the absolute path to sap-bridge (found in bin folder) or follow your AI IDE's documentation.

Windows

{
  "mcpServers": {
    "sap-bridge": {
      "command": "C:\\absolute\\path\\to\\sap-bridge.exe",
      "args": [],
      "env": {}
    }
  }
}

macOS / Linux

{
  "mcpServers": {
    "sap-bridge": {
      "command": "/absolute/path/to/sap-bridge",
      "args": [],
      "env": {}
    }
  }
}

Registering the Skill

Place the contents of sap-dev folder into your AI IDE's skill directory.

Note: Every AI IDE slightly differs in how it handles skill registration. Read the documentation of your AI IDE or ask your AI agent to help you with the registration process.