JinDaGe - MCP ABAP ADT MCP Details

article

README

🚀 MCP 协议 ABAP 工具安装指南

MCP 协议 ABAP 工具为开发者提供了与 SAP 系统交互的便捷方式。本指南将详细介绍该工具的安装、配置、启动及使用方法。

🚀 快速开始

克隆项目

首先，将项目克隆到本地，并进入项目目录：

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

配置环境变量

在项目根目录下编辑 .env 文件，配置 SAP 系统的相关信息：

SAP_CLIENT=001  # SAP Client ID，默认为001
SAP_SERVER=192.168.1.100  # SAP 服务地址，根据实际配置修改
SAP_PORT=3200  # SAP 端口，默认为3200
SAP_USER=user  # SAP 用户名，默认为user
SAP_PASSWORD=password  # SAP 密码，默认为password
SAP_LANG=en  # SAP 语言，默认为en（英文）
TLS_REJECT_UNAUTHORIZED=false  # 是否拒绝自签名证书，默认false

安装依赖项

运行以下命令安装项目所需的依赖：

npm install

构建项目

执行以下命令构建项目：

npm run build

启动服务

最后，启动 MCP 协议 ABAP 工具服务：

npx @modelcontextprotocol/core serve dist/index.js

✨ 主要特性

提供了丰富的命令行工具，方便开发者进行各种操作。
支持详细的日志记录，便于问题排查。
提供 Web UI 和 API 文档，方便用户使用和开发。

📦 安装指南

创建 .env 文件

在项目根目录下创建 .env 文件，内容如下：

SAP_CLIENT=001  # SAP 客户端编号，默认001
SAP_SERVER=192.168.1.100  # SAP 服务器地址，默认192.168.1.100
SAP_PORT=3200  # SAP 端口，默认3200
SAP_USER=user  # SAP 用户名，默认user
SAP_PASSWORD=password  # SAP 密码，默认password
SAP_LANG=en  # SAP 语言，默认en（英文）
TLS_REJECT_UNAUTHORIZED=false  # 是否拒绝自签名证书，默认false

安装依赖

运行以下命令安装项目所需的依赖项：

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

💻 使用示例

启动 MCP 服务

完成以上步骤后，启动 MCP 协议 ABAP 工具：

npx @modelcontextprotocol/inspector serve dist/index.js

获取帮助信息

npx @modelcontextprotocol/core help

运行时检查

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

打印日志

npx @modelcontextprotocol/core logs --level debug

📚 详细文档

MCP 协议 ABAP 工具启动检查

确保以下条件满足：

Node.js 版本 >= 14.x
npm 版本 >= 6.x
网络连接正常，可以访问 SAP 系统
SAP 系统已启用 ADT（ABAP Development Tools）服务

运行以下命令检查服务状态：

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

SAP 连接问题排查

如果无法连接到 SAP 系统，请检查以下内容：

确保 SAP 服务器地址和端口正确
确保 SAP 用户名和密码正确
确保网络连接正常
确保 SAP 系统已启用远程访问功能

运行以下命令测试连接：

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

MCP 协议 ABAP 工具可用性检查

启动服务后，可以通过以下 URL 访问工具：

Web UI：http://localhost:3000/ui
API 文档：http://localhost:3000/docs

MCP 协议 ABAP 工具错误代码

以下是常见的错误代码及其说明：

ECONNREFUSED - 连接被拒绝，通常是因为 SAP 服务未启动或地址错误。
ETIMEOUT - 连接超时，可能是网络问题或 SAP 服务不可用。
BAD_REQUEST - 请求格式错误，请检查请求参数是否正确。
Unauthorized - 未经授权，请检查用户权限。
NotFound - 资源未找到，请确保路径和端点正确。

MCP 协议 ABAP 工具日志记录

工具支持详细日志记录，可以通过以下命令查看：

npx @modelcontextprotocol/core logs --level debug

MCP 协议 ABAP 工具配置文件位置

默认情况下，工具会在项目根目录下查找 .env 文件。如果需要指定其他路径，请在运行时使用 --config 参数：

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

MCP 协议 ABAP 工具版本信息

查看当前工具版本：

npx @modelcontextprotocol/core version

附录：MCP 协议 ABAP 工具 API 文档

完整的 API 文档可以通过以下链接访问：

Swagger UI: http://localhost:3000/docs
OpenAPI 规范: http://localhost:3000/swagger.json

MCP ABAP ADT