MCP SAP GUI Server

You can automate SAP GUI interactions using a dedicated MCP SAP GUI Server. It enables programmatic control of SAP transactions and GUI actions, letting you launch transactions, click in the SAP window, type text, and manage sessions from your MCP client.

How to use

Use an MCP client to interact with the SAP GUI server. Start a session by launching a transaction, then perform actions such as clicking coordinates, moving the mouse, and typing text. You can drive a sequence of steps to complete a SAP transaction, verify results through subsequent screenshots, and finally end the session to close the transaction.

Typical workflow you will follow:

• Start a SAP GUI session by launching a transaction code (for example VA01).
• Interact with the SAP window by clicking at precise coordinates, moving the mouse, and typing required input.
• Capture and review screenshots after each action to verify the expected state.
• End the current SAP transaction when your task is complete.

How to install

Prerequisites you need on your system:
- Python 3.8 or higher
- SAP GUI installed and configured
- Valid SAP credentials (system, client, user, password)
- Node.js (required for npx)

Step 1. Install or prepare the server

• Clone the folder and run the automated Install using setup.bat
• The setup process guides you through the build and can integrate with Cline or Roo if you choose

Step 2. Alternative manual install

• Run the build script: build.bat
• This builds the server components for SAP GUI automation

Step 3. Configure SAP credentials

• Copy .env.example to .env
• Update the values with your SAP credentials (system, client, user, password, etc.)

Step 4. Test the server

• Run the inspector to test connectivity and responses: run.bat debug
• Validate the server is responding and can communicate with SAP GUI

Step 5. Configure MCP integration

• Use the integration script to configure MCP settings for different targets:

integrate.bat roo # Configure for Roo```
- The script detects the correct settings file path, creates backups, updates MCP configuration safely, and validates changes to prevent corruption

Manual configuration example (when needed)

"mcp-sap-gui": {
  "command": "python",
  "args": [
    "-m",
    "sap_gui_server.server"
  ],
  "cwd": "PATH_TO_YOUR_FOLDER/mcp-sap-gui",
  "disabled": false,
  "autoApprove": []
}

Step 6. Important safety and tool prompt Use the provided prompt to explain the tool to your AI model and follow the safety precautions when interacting with SAP GUI. This ensures careful, auditable actions and prevents unintended operations.

Configuration and tools

The server provides a standard MCP interface with a set of tools to manage SAP GUI interactions, transactions, and screenshots. You can launch transactions, perform clicks, move the mouse, type text, scroll, and save screenshots as needed.

{
  "mcp-sap-gui": {
    "command": "python",
    "args": ["-m", "sap_gui_server.server"],
    "cwd": "PATH_TO_YOUR_FOLDER/mcp-sap-gui",
    "disabled": false,
    "autoApprove": []
  }
}

Security and best practices

Handle SAP credentials with care. Store credentials in the designated environment file and restrict access to the file. When automating, verify the SAP GUI state before each action, double-check coordinates, and document each step with clear annotations. If you are unsure about an element position, request user verification before proceeding.

Notes and troubleshooting

If you encounter issues, verify that SAP GUI is installed and configured correctly, the credentials in the environment file are accurate, and the integration scripts have been executed with the correct target (Cline or Roo). Ensure the working directory points to the SAP GUI server folder and that Python and Node.js are available on your system.

Available tools

launch_transaction

Launch a specific SAP transaction code to start a new SAP GUI workflow.

end_transaction

End the current SAP GUI transaction and close the session gracefully.

sap_click

Click at precise (x, y) coordinates within the SAP GUI window to interact with controls.

sap_move_mouse

Move the mouse cursor to specific (x, y) coordinates inside the SAP GUI window.

sap_type

Type text into the currently focused SAP GUI input field or control.

sap_scroll

Scroll the SAP GUI window in a given direction to reveal hidden content.

save_last_screenshot

Capture and save the last SAP GUI window screenshot to a file, returning the file path.