使用说明

项目简介

ABAP-ADT-API MCP-Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它作为 abap-adt-api 的封装，旨在简化 ABAP 系统与 MCP 客户端（如 Cline）之间的通信。该服务器提供了一系列工具和资源，用于管理 ABAP 对象、处理传输请求、执行代码分析等，从而提升 ABAP 开发工作流的效率。

主要功能点

• 安全认证：通过 'login' 工具安全地连接到 ABAP 系统。
• ABAP 对象管理：无缝创建、读取、更新和删除 ABAP 对象。
• 传输处理：使用 'createTransport' 和 'transportInfo' 等工具管理传输请求。
• 代码分析：执行语法检查和获取代码完成建议。
• 扩展性：可以根据需要轻松扩展服务器的功能和资源。
• 会话管理：通过 'dropSession' 和 'logout' 管理会话缓存和终止。

安装步骤

1. 环境准备

   • 确保已安装 Node.js。
   • 准备好 ABAP 系统的连接凭据和 URL。

2. 克隆仓库

   git clone https://github.com/mario-andreschak/mcp-abap-abap-adt-api.git
   cd mcp-abap-abap-adt-api
   

3. 安装依赖

   npm install
   

4. 配置环境变量

   • 复制 '.env.example' 文件并重命名为 '.env'：

     cp .env.example .env
     

   • 编辑 '.env' 文件，填入您的 SAP 连接信息，例如：

     SAP_URL=https://your-sap-server.com:44300
     SAP_USER=YOUR_SAP_USERNAME
     SAP_PASSWORD=YOUR_SAP_PASSWORD
     SAP_CLIENT=YOUR_SAP_CLIENT
     SAP_LANGUAGE=YOUR_SAP_LANGUAGE
     

     'SAP_CLIENT' 和 'SAP_LANGUAGE' 是可选的，但建议配置。

5. 构建项目

   npm run build
   

6. 启动服务器

   npm run start
   

服务器配置

以下 JSON 配置信息用于 MCP 客户端（如 Cline）连接 ABAP-ADT-API MCP-Server。您需要将 '{PATH_TO_YOUR}' 替换为实际仓库的路径。

{
  "serverName": "mcp-abap-abap-adt-api",  // 自定义服务器名称
  "command": "node",                     // 启动服务器的命令，这里使用 Node.js
  "args": [                             // 命令参数
    "{PATH_TO_YOUR}/mcp-abap-abap-adt-api/dist/index.js" //  指向编译后的服务器入口文件
  ]
}

基本使用方法

服务器启动后，您可以使用任何 MCP 客户端（例如 Cline）与其交互。

• 通过 MCP 客户端配置连接到该服务器。
• 使用客户端提供的界面或命令，调用服务器提供的各种工具，例如：
  • 'searchObject': 搜索 ABAP 对象。
  • 'transportInfo': 获取对象传输信息。
  • 'lock': 锁定 ABAP 对象。
  • 'setObjectSource': 设置 ABAP 对象源代码。
  • 'syntaxCheckCode': 检查 ABAP 代码语法。

详细的工具使用方法和工作流程，请参考仓库 'README.md' 文件中的 "Custom Instruction" 部分。