MCP Sap Gui

An MCP server for SAP GUI automation, providing tools for programmatic control of SAP transactions, including starting transactions, interface interaction, and screen capture.

Developer tools Operating system automation #SAP Automation #GUI Control #MCP Service .Python

rating : 2.5 points

downloads : 31

update time : 2025-04-28

What is the MCP SAP GUI Server?

The MCP SAP GUI Server is a tool for automating SAP GUI operations, allowing users to start and manage SAP transactions programmatically. It provides a rich set of APIs to simulate mouse clicks, input text, scroll the screen, etc.

How to use the MCP SAP GUI Server?

Users can start SAP transactions with simple commands, perform mouse and keyboard operations, and get real-time screenshot feedback. The server supports multiple return formats to meet different needs.

Applicable Scenarios

Suitable for enterprise users who need to handle SAP transactions frequently, such as order management, inventory query, etc.

Main Features

Launch SAP TransactionsStart a new SAP session by specifying the transaction code (e.g., VA01).

Simulate Mouse ClicksSimulate a left - mouse click at the specified coordinate position.

Input TextInput the specified text at the current cursor position.

Save ScreenshotsSave the latest captured SAP GUI window screenshot locally.

Advantages and Limitations

Advantages

Improve work efficiency and reduce repetitive work.

Support multi - format screenshot returns for further analysis.

Easy to integrate into existing systems.

Limitations

Need to install and configure the SAP GUI client.

Some advanced functions may depend on precise coordinate positioning.

Have certain requirements for the network environment.

How to Use

Installation and Configuration

Clone the project repository and run the installation script setup.bat, and complete the configuration as prompted.

Start the Server

Build and test the server with build.bat to ensure everything runs normally.

Call the Tool

Use the provided API to call functions, such as launch_transaction to start an SAP transaction.

Usage Examples

Start Sales Order CreationUse launch_transaction to start the sales order creation transaction VA01.

Input Customer NumberUse sap_type to input a specific value in the customer number field.

Frequently Asked Questions

Do I need to install additional software?

How to verify if the server is working properly?

Related Resources

Official Documentation

Detailed API documentation and usage guides.

GitHub Repository

Source code and Issue tracking.

🚀 MCP SAP GUI

MCP is a Multi-language Control Platform designed to execute automated tasks and scripts within the SAP system. This documentation aims to guide you on how to connect to SAP GUI using MCP and interact with it by writing Python scripts.

🚀 Quick Start

✨ Features

Automation: Execute automated tasks and scripts in the SAP system.
Multi-language Support: Support multiple languages for flexible use.
Scripting: Interact with SAP GUI through Python scripts.

📦 Installation

Install MCP

Download the latest version of MCP.
Extract the package and run the installation program.
Follow the prompts to complete the installation process.

Configure MCP to Connect to SAP GUI

Open the MCP settings interface.
Add a new "SAP GUI" connection.
Fill in the following information:
- Name: Give your connection a meaningful name (e.g., MYSAPGUI-01).
- Hostname/IP Address: Enter the address of the SAP server (e.g., 192.168.1.100).
- Port: The default port for SAP GUI is 32768, but you can also use other custom ports.
The configuration is complete.

💻 Usage Examples

Basic Usage

Example: Execute MM03 (Material Master Data Maintenance)

Open MCP and select your "SAP GUI" connection.
Enter the following command in the console:
```
mcp sap connect MYSAPGUI-01
```
After successfully connecting, you can execute the transaction code MM03:
```
mcp sap transaction MM03
```

Example: Use Scripts for Batch Processing

Create a Python script to automate tasks:

from mcp import SapGuiController

# Connect to SAP GUI
controller = SapGuiController('MYSAPGUI-01')

# Open transaction ME21N (Purchase Requisition)
controller.open_transaction('ME21N')

# Input the material number
controller.input_field('Material', '12345')

# Submit the transaction
controller.submit()

📚 Documentation

Project Structure and Files

Directory Structure

mcp-sap-gui/
├── src/
│   └── sap_gui_server/
│       ├── __init__.py
│       ├── sap_controller.py  # Interaction logic for SAP GUI
│       └── server.py         # MCP server implementation
├── tests/
│   ├── __init__.py
│   ├── test_sap_controller.py
│   └── test_server.py
├── build.bat          # Compilation and testing script
├── integrate.bat      # Integration script (for Cline/Roo)
├── integrate.py       # Python script for secure MCP settings update
├── requirements.txt   # Production dependencies
└── requirements-dev.txt  # Development dependencies

Key Files

sap_controller.py: Contains the specific logic for interacting with SAP GUI, such as opening transactions, inputting fields, and submitting.
server.py: Implements the communication protocol and request handling of the MCP server.
tests/: The test suite, including unit tests and integration tests.

🔧 Technical Details

Development Guide

Run Tests

Use the MCP checker to run a full test:
```
./run.bat full
```
Or use the test suite:
- Ensure that SAP GUI is installed and configured.
- Run the tests:
```
run.bat test server
```

Debugging and Logging

During development, enable debug mode to get detailed log information:

from sap_gui_server.sap_controller import SapController

controller = SapController('MYSAPGUI-01', debug=True)

📄 License

[MIT License]

This documentation comprehensively introduces how to use the MCP platform to interact with SAP GUI, providing detailed code examples and project structure information.