MCP ABAP ADT

🚀 MCP Protocol ABAP Tool Installation Guide

This guide provides a step - by - step process for installing and using the MCP Protocol ABAP Tool, as well as troubleshooting tips and information about available commands and error codes.

🚀 Quick Start

📦 Installation

1. Clone the project

git clone https://github.com/your-repository.git
cd mcp-abap-adt

2. Configure environment variables Edit the .env file:

SAP_CLIENT=001  # SAP Client ID, default is 001
SAP_SERVER=192.168.1.100  # SAP service address, modify according to actual configuration
SAP_PORT=3200  # SAP port, default is 3200
SAP_USER=user  # SAP username, default is user
SAP_PASSWORD=password  # SAP password, default is password
SAP_LANG=en  # SAP language, default is en (English)
TLS_REJECT_UNAUTHORIZED=false  # Whether to reject self - signed certificates, default is false

3. Install dependencies Run the following command:

npm install

4. Build the project Run:

npm run build

5. Start the service Run:

npx @modelcontextprotocol/core serve dist/index.js

🛠️ Startup Checks

Ensure the following conditions are met:

1. Node.js version >= 14.x
2. npm version >= 6.x
3. The network connection is normal and the SAP system can be accessed.
4. The ADT (ABAP Development Tools) service is enabled on the SAP system.

Run the following command to check the service status:

curl http://localhost:3000/api/healthz

📄 Create the .env File

Create a .env file in the project root directory with the following content:

SAP_CLIENT=001  # SAP client number, default is 001
SAP_SERVER=192.168.1.100  # SAP server address, default is 192.168.1.100
SAP_PORT=3200  # SAP port, default is 3200
SAP_USER=user  # SAP username, default is user
SAP_PASSWORD=password  # SAP password, default is password
SAP_LANG=en  # SAP language, default is en (English)
TLS_REJECT_UNAUTHORIZED=false  # Whether to reject self - signed certificates, default is false

📦 Install Dependencies

Run the following command to install the dependencies required by the project:

npm install @modelcontextprotocol/core @modelcontextprotocol/types @types/node --save

🚀 Start the MCP Service

After completing the above steps, start the MCP Protocol ABAP Tool:

npx @modelcontextprotocol/inspector serve dist/index.js

🕵️ Troubleshooting SAP Connection Issues

If you cannot connect to the SAP system, check the following:

1. Ensure that the SAP server address and port are correct.
2. Ensure that the SAP username and password are correct.
3. Ensure that the network connection is normal.
4. Ensure that the remote access function is enabled on the SAP system.

Run the following command to test the connection:

curl http://localhost:3000/api/test-connectivity

🔍 Check Tool Availability

After starting the service, you can access the tool via the following URLs:

• Web UI: http://localhost:3000/ui
• API Documentation: http://localhost:3000/docs

💻 Available Tools

The following are the commands supported by the current MCP Protocol ABAP Tool and their usage instructions:

1. Get help information

npx @modelcontextprotocol/core help

2. Runtime check

npx @modelcontextprotocol/core check --server http://localhost:3000

3. Print logs

npx @modelcontextprotocol/core logs --level debug

❌ Error Codes

The following are common error codes and their descriptions:

1. ECONNREFUSED - Connection refused, usually because the SAP service is not started or the address is incorrect.
2. ETIMEOUT - Connection timed out, possibly due to network issues or the SAP service being unavailable.
3. BAD_REQUEST - Incorrect request format, please check the request parameters.
4. Unauthorized - Unauthorized, please check user permissions.
5. NotFound - Resource not found, please ensure the path and endpoint are correct.

📜 Logging

The tool supports detailed logging, which can be viewed via the following command:

npx @modelcontextprotocol/core logs --level debug

⚙️ Configuration File Location

By default, the tool will look for the .env file in the project root directory. If you need to specify another path, use the --config parameter at runtime:

npx @modelcontextprotocol/core serve dist/index.js --config ./custom-config.json

📋 Version Information

View the current tool version:

npx @modelcontextprotocol/core version

📚 API Documentation

The complete API documentation can be accessed via the following links:

• Swagger UI: http://localhost:3000/docs
• OpenAPI Specification: http://localhost:3000/swagger.json