Abap Doc MCP

ABAPDocMCP——WRICEF技术规范生成器

从SAP传输请求生成结构化ABAP技术规范文档的MCP工具。 通过ADT REST API连接到任何SAP系统，并生成涵盖所有WRICEF对象类型的现成Markdown规范。

______________________________________________________________________

它的作用

GenerateWricefTechSpec 是一个MCP（模型上下文协议）工具，它：

1. 读取一个或多个 运输请求编号 从您的SAP系统
2. 获取运输对象及其 源代码 通过ADT
3. 分析数据库表、功能模块调用、授权对象、错误处理模式和性能反模式的来源
4. 生成一个完全结构化的 Markdown技术规范 最多可配置32个部分
5. 包括a 美人鱼对象关系图 按运输方式分组的颜色编码对象

______________________________________________________________________

支持的WRICEF类型

一个WRICEF可以跨越 多个传输请求 并包含 混合对象类型 --所有这些都在一个规范中处理。

______________________________________________________________________

快速开始

1.先决条件

• 转到1.21+（从源代码构建） 或 使用预构建的二进制文件
• 启用ADT的SAP系统(/sap/bc/adt/ ICF服务处于活动状态）

2.建造

git clone https://github.com/SaurabhVC/ABAPDocMCP.git
cd ABAPDocMCP
go build -o abapdocmcp ./cmd/vsp/main.go

3.配置克劳德桌面

增添 ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "abapdocmcp": {
      "command": "/path/to/abapdocmcp",
      "env": {
        "SAP_URL": "https://your-sap-host:44300",
        "SAP_USER": "your-username",
        "SAP_PASSWORD": "your-password",
        "SAP_CLIENT": "100"
      }
    }
  }
}

自签名证书： 添加 "SAP_INSECURE": "true" 转到env块。

4.配置克劳德代码

添加 .mcp.json 到您的项目根目录：

{
  "mcpServers": {
    "abapdocmcp": {
      "command": "/path/to/abapdocmcp",
      "env": {
        "SAP_URL": "https://your-sap-host:44300",
        "SAP_USER": "your-username",
        "SAP_PASSWORD": "your-password",
        "SAP_CLIENT": "100"
      }
    }
  }
}

______________________________________________________________________

工具参考-- GenerateWricefTechSpec

必填参数

WRICEF元数据（可选）

人们

系统

源代码丰富

接口特定

特定增强功能

表格特定

工作流特定

OData/RAP特定

其他

______________________________________________________________________

示例用法（克劳德语）

最小值——只是一个运输编号：

GenerateWricefTechSpec(
  transport_numbers = "DEVK900123"
)

完整报告规范：

GenerateWricefTechSpec(
  transport_numbers  = "DEVK900123,DEVK900124",
  wricef_type        = "REPORT",
  wricef_id          = "ZSD-R-001",
  complexity         = "M",
  cr_number          = "CHG0012345",
  module             = "SD",
  developer_name     = "John Smith",
  developer_user_id  = "JSMITH",
  reviewer_name      = "Mary Johnson",
  system_id          = "DEV",
  client             = "100"
)

增强规格：

GenerateWricefTechSpec(
  transport_numbers  = "DEVK900145",
  wricef_type        = "ENHANCEMENT",
  wricef_id          = "ZFI-E-001",
  complexity         = "S",
  module             = "FI",
  enhancement_type   = "BAdI",
  enhancement_name   = "BADI_ACC_DOCUMENT",
  original_program   = "SAPLGL_ACCOUNT_ASSIGNMENT"
)

接口规格：

GenerateWricefTechSpec(
  transport_numbers      = "DEVK900130",
  wricef_type            = "INTERFACE",
  wricef_id              = "ZMM-I-001",
  complexity             = "L",
  module                 = "MM",
  interface_direction    = "Outbound",
  interface_protocol     = "IDoc",
  interface_frequency    = "Event-driven"
)

______________________________________________________________________

生成的部分

所有部分均由以下人员控制 tech-spec-config.json默认设置（按顺序）：

______________________________________________________________________

美人鱼对象关系图

该图是从传输对象自动生成的，并且在获取源代码时，它丰富了以下内容的边：

• INCLUDE 声明→ includes 边缘
• CALL FUNCTION / CALL METHOD → calls FM / calls method 边缘
• CREATE OBJECT / NEW → instantiates 边缘

显示的代码对象类型 （表、结构、域等除外）：

当WRICEF跨越 多个传输请求，每个TR显示为带标签的子图。

______________________________________________________________________

配置节-- tech-spec-config.json

地方 tech-spec-config.json 在与二进制文件（或工作目录）相同的目录中，自定义显示哪些部分以及显示顺序：

{
  "sections": [
    "documentInfo",
    "developerInfo",
    "changeRequest",
    "wricefClassification",
    "transportDetails",
    "transportContents",
    "businessRequirement",
    "scopeAssumptions",
    "technicalDesign",
    "objectRelationDiagram",
    "reportDetails",
    "interfaceDetails",
    "messageMapping",
    "enhancementDetails",
    "formDetails",
    "workflowDetails",
    "odataDetails",
    "pseudocode",
    "databaseObjects",
    "calledFunctions",
    "authorizationObjects",
    "errorHandling",
    "performanceConsiderations",
    "testScenarios",
    "additionalNotes",
    "changeHistory",
    "signOff"
  ],
  "sectionTitles": {
    "documentInfo": "Document Information",
    "objectRelationDiagram": "Object Relationship Diagram",
    "reportDetails": "Selection Screen / Input Parameters"
  }
}

• sections --要包括的部分ID的有序列表；省略任何ID以抑制该部分
• sectionTitles --覆盖任何标题文本；仅指定要更改其标题的部分

32个节ID及其默认标题的完整列表位于 技术规范配置json 项目根目录下的文件。

______________________________________________________________________

示例输出

看 示例_价格_技术_规格.md 完整示例显示：

• R——报告 规范（ZSD-R-001），带选择屏幕、ALV布局、伪代码、DB表、FM调用、ATC、认证对象
• I——接口 带字段映射表的规范（ZMM-I-001）
• E--增强 规范（ZFI-E-001），含BAdI详细信息和伪代码

______________________________________________________________________

配置参考

______________________________________________________________________

源代码结构

ABAPDocMCP/
├── cmd/vsp/main.go                   # Entry point (CLI + MCP server)
├── internal/
│   ├── mcp/
│   │   ├── server.go                 # Tool registration
│   │   └── handlers_techspec.go      # GenerateWricefTechSpec handler
│   └── techspec/
│       ├── config.go                 # Section config loader (tech-spec-config.json)
│       ├── mermaid.go                # Mermaid diagram generator
│       └── generator.go             # 32-section spec renderer
├── pkg/adt/                          # SAP ADT REST API client
│   ├── client.go
│   ├── transport.go                  # GetTransport, ListTransports
│   └── workflows.go                  # GetSource (PROG, CLAS, FUNC, INCL …)
├── tech-spec-config.json             # Default section order & titles
└── SAMPLE_WRICEF_TECH_SPEC.md        # Sample generated output

______________________________________________________________________

建筑

# Current platform
go build -o abapdocmcp ./cmd/vsp/main.go

# All platforms (requires make)
make build-all

______________________________________________________________________

许可证

麻省理工学院