返回市场
MCP-SAP文档服务器

MCP-SAP文档服务器

作者:marianfoo101 星标更新:2025-10-30

项目介绍

SAP 文档 MCP 服务器

一个快速、轻量级的 MCP 服务器,通过高效的 BM25 全文搜索提供对官方 SAP 文档(SAPUI5、CAP、OpenUI5 API 和示例、wdi5)的统一访问。可以远程使用(托管 URL)或本地运行。

公共服务器(MCP Streamable HTTP): https://mcp-sap-docs.marianzeis.de/mcp
本地 Streamable HTTP(默认:3122,可通过 MCP_PORT 配置): http://127.0.0.1:3122/mcp
本地 HTTP 状态: http://127.0.0.1:3001/status


快速开始

<details> <summary><b>使用托管服务器(推荐)</b></summary>

将您的 MCP 客户端指向 Streamable HTTP URL:

https://mcp-sap-docs.marianzeis.de/mcp

从 shell 中验证:

# 应返回带有 api_last_activity 的 JSON
curl -sS https://mcp-sap-docs.marianzeis.de/status | jq .

# 应返回带有迁移信息的 HTTP 410(SSE 端点已弃用)
curl -i https://mcp-sap-docs.marianzeis.de/sse
</details> <details> <summary><b>本地运行(STDIO + 本地 HTTP 状态 + Streamable HTTP)</b></summary>
# 从仓库根目录
npm ci
./setup.sh # 执行此脚本以克隆 GitHub 文档子模块
npm run build

# 启动 MCP 服务器(STDIO)
node dist/src/server.js

# 或启动 Streamable HTTP 服务器
npm run start:streamable

本地健康检查

# HTTP 服务器
curl -sS http://127.0.0.1:3001/status | jq .

# Streamable HTTP 服务器(本地及部署默认)
curl -sS http://127.0.0.1:3122/health | jq .
</details>

您将获得什么

🔍 统一文档搜索

  • search – 在所有官方 SAP 文档源中进行智能过滤搜索
  • fetch – 获取完整的文档/片段,并进行智能格式化

🌐 社区与帮助门户

  • sap_community_search – 实时 SAP 社区帖子,显示前三条结果的完整内容(如有需要,智能截断至 75k 字符)
  • sap_help_search – 跨 SAP 帮助门户文档进行全面搜索
  • sap_help_get – 获取完整的 SAP 帮助页面及其元数据(如有需要,智能截断至 75k 字符)

从您的 MCP 客户端连接

远程 URL:使用公共 MCP Streamable HTTP 终端
本地/STDIO:运行 node dist/src/server.js 并将客户端指向命令 + 参数
本地/Streamable HTTP:运行 npm run start:streamable 并将客户端指向 http://127.0.0.1:3122/mcp

以下是流行客户端的复制粘贴设置。每个块都有远程、本地和 Streamable HTTP 选项。


Claude(桌面/网络“连接器”)

<details> <summary><b>远程(推荐)— 添加自定义连接器</b></summary>
  1. 打开 Claude 设置 → 连接器 → 添加自定义连接器
  2. 粘贴 URL:
https://mcp-sap-docs.marianzeis.de/mcp
  1. 保存;Claude 将使用 MCP Streamable HTTP 协议进行通信。

文档:模型上下文协议 "连接到远程 MCP 服务器"(展示如何让 Claude 连接到 MCP 服务器)。

</details> <details> <summary><b>本地(STDIO)— 添加本地 MCP 服务器</b></summary>

将 Claude 指向命令和参数:

命令: node
参数: ["<绝对路径到您的仓库>/dist/src/server.js"]

Claude 的用户快速入门展示了如何通过指定命令/参数对添加本地服务器。

</details> <details> <summary><b>本地(Streamable HTTP)— 最新 MCP 协议</b></summary>

对于最新 MCP 协议(2025-03-26)支持 Streamable HTTP:

  1. 启动 Streamable HTTP 服务器:
npm run start:streamable
  1. 使用以下 URL 添加自定义连接器:
http://127.0.0.1:3122/mcp

这提供了更好的性能并支持最新的 MCP 功能,包括会话管理和可恢复性。

</details>

Cursor

<details> <summary><b>远程(MCP Streamable HTTP)</b></summary>

创建或编辑 ~/.cursor/mcp.json

{
  "mcpServers": {
    "sap-docs-remote": {
      "url": "https://mcp-sap-docs.marianzeis.de/mcp"
    }
  }
}
</details> <details> <summary><b>本地(STDIO)</b></summary>

~/.cursor/mcp.json

{
  "mcpServers": {
    "sap-docs": {
      "command": "node",
      "args": ["/绝对路径/to/dist/src/server.js"]
    }
  }
}
</details>

Eclipse(GitHub Copilot)

Eclipse 用户可以将 SAP 文档 MCP 服务器与 GitHub Copilot 集成,以便无缝访问 SAP 开发文档。

<details> <summary><b>远程(推荐)— 托管服务器</b></summary>

先决条件

  • Eclipse 版本:2024-09 或更高
  • GitHub Copilot 扩展:来自 Eclipse Marketplace 的最新版本
  • GitHub 账户:具有 Copilot 访问权限
  • 注意:完整的 ABAP ADT 集成尚未支持

配置步骤

  1. 安装 GitHub Copilot 扩展

  2. 打开 MCP 配置

    • 通过按 <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>I</kbd> 打开 Copilot 聊天
    • 在聊天区域点击“配置工具...”图标
  3. 添加 SAP 文档 MCP 服务器 在“服务器配置”中添加以下内容并点击“应用”

    {
      "servers": {
        "SAPDocs": {
          "type": "http",
          "url": "https://mcp-sap-docs.marianzeis.de/mcp"
        }
      }
    }
    
  4. 验证配置

    • 点击“应用”后,该服务器应出现在您的 MCP 服务器列表中
    • 当处于活动状态时,状态应显示为“已连接”

在 Eclipse 中使用 SAP 文档

配置完成后,您可以在 Eclipse 中使用增强的 SAP 文档的 Copilot 聊天:

示例查询:

如何在 UI5 中实现 Wizard 控件?
ABAP 7.58 的内联声明语法是什么?
给我看一些关于 RAP 开发的最佳实践
查找用于 OData 服务的 wdi5 测试示例

可用工具:

  • search - 统一搜索所有 SAP 开发(UI5、CAP、ABAP、测试)并智能过滤 ABAP 版本
  • fetch - 获取任何来源的完整文档
  • sap_community_search - SAP 社区集成
  • sap_help_search - SAP 帮助门户访问
</details> <details> <summary><b>本地设置 — 用于离线使用</b></summary>

本地 MCP 服务器配置

{
  "name": "SAP 文档 MCP(本地)",
  "description": "本地 SAP 文档服务器",
  "command": "npm",
  "args": ["start"],
  "cwd": "/绝对路径/to/your/sap-docs-mcp",
  "env": {
    "NODE_ENV": "production"
  }
}

本地设置先决条件:

  1. 在本地克隆并构建此仓库
  2. 运行 npm run setup 初始化所有文档源
  3. 确保服务器正确启动 npm start
</details>

VS Code(GitHub Copilot Chat)

<details> <summary><b>远程(推荐)— 不需要设置</b></summary>

先决条件:VS Code 1.102+,启用 MCP 支持(默认启用)。

快速设置

在工作区创建 .vscode/mcp.json

{
  "servers": {
    "sap-docs": {
      "type": "http",
      "url": "https://mcp-sap-docs.marianzeis.de/mcp"
    }
  }
}

使用远程服务器

  1. 在工作区保存 .vscode/mcp.json 文件
  2. VS Code 将自动检测并启动 MCP 服务器
  3. 打开聊天视图并选择 代理模式
  4. 点击 工具按钮查看可用的 SAP 文档工具
  5. 提问如“如何在 SAPUI5 中实现身份验证?”

优点

  • ✅ 不需要本地安装
  • ✅ 始终更新的文档
  • ✅ 自动更新和维护
  • ✅ 跨所有项目工作

注意:首次连接时,系统会提示您信任远程 MCP 服务器。

</details> <details> <summary><b>本地设置 — 用于离线使用</b></summary>

本地 STDIO 服务器

{
  "servers": {
    "sap-docs-local": {
      "type": "stdio",
      "command": "node",
      "args": ["<绝对路径>/dist/src/server.js"]
    }
  }
}

本地 HTTP 服务器

{
  "servers": {
    "sap-docs-http": {
      "type": "http",
      "url": "http://127.0.0.1:3122/mcp"
    }
  }
}

(首先使用 npm run start:streamable 启动本地服务器)

替代设置方法

  • 命令面板:运行 MCP: 添加服务器 → 选择服务器类型 → 提供详细信息 → 选择作用域
  • 用户配置:运行 MCP: 打开用户配置 以跨所有工作区进行全局设置

参见 Microsoft 的 "在 VS Code 中使用 MCP 服务器" 以获取完整文档。

</details>

Raycast

<details> <summary><b>远程(MCP Streamable HTTP)</b></summary>

打开 Raycast → 打开命令“管理服务器(MCP)”→ 导入以下 JSON

{
  "mcpServers": {
    "sap-docs": {
      "command": "npx",
      "args": ["mcp-remote@latest", "https://mcp-sap-docs.marianzeis.de/mcp"]
    }
  }
}
</details> <details> <summary><b>本地(STDIO)</b></summary>

打开 Raycast → 打开命令“管理服务器(MCP)”→ 导入以下 JSON

{
  "mcpServers": {
    "sap-docs": {
      "command": "node",
      "args": ["/绝对路径/to/dist/src/server.js"]
    }
  }
}
</details>

Raycast 默认会在每次使用 MCP 工具时询问确认。您可以启用自动确认:

打开 Raycast → Raycast 设置 → AI → 模型上下文协议 → 勾选“自动确认所有工具调用”


功能

🔍 高级搜索能力

  • 统一搜索所有官方 SAP 文档,智能过滤 ABAP 版本
  • BM25 全文搜索使用 SQLite FTS5,快速相关结果(平均查询时间约 15ms)
  • 上下文感知评分自动停用词过滤和短语检测
  • 特定版本过滤 - 默认显示最新 ABAP 版本,仅在请求时显示特定版本

🌐 实时外部集成

  • SAP 社区:使用“最佳匹配”算法和参与度指标检索完整内容
  • SAP 帮助门户:直接 API 访问所有 SAP 产品文档(S/4HANA、BTP、Analytics Cloud)
  • 高效处理:批量内容检索和智能缓存,快速响应时间

💡 智能特性

  • 自动内容增强:代码高亮和示例分类
  • 智能排名:上下文感知评分,带来源特定权重
  • 性能优化:轻量级 SQLite FTS5,无外部机器学习依赖

包含的内容

此 MCP 服务器提供跨多个产品领域的全面 SAP 开发文档的统一访问。所有来源都通过 search 工具同时搜索,具有智能过滤和排名。

📊 文档覆盖概述

来源类别来源文件数量描述
ABAP 开发4 个来源40,800+ 文件官方 ABAP 关键字文档(8 个版本),速查表,Fiori 展示,社区指南
UI5 开发6 个来源12,000+ 文件SAPUI5 文档,OpenUI5 API/示例,TypeScript,工具,Web 组件,自定义控件
CAP 开发2 个来源250+ 文件云应用程序编程模型文档和 Fiori Elements 展示
云与部署3 个来源500+ 文件SAP Cloud SDK(JS/Java),Cloud SDK for AI,Cloud MTA 构建工具
测试与质量2 个来源260+ 文件wdi5 E2E 测试框架,SAP 样式指南

🔍 ABAP 开发来源

  • 官方 ABAP 关键字文档 (/abap-docs) - 40,761+ 筛选 ABAP 文件跨越 8 个版本(7.52-7.58 + 最新),智能版本过滤
    📁 GitHub: marianfoo/abap-docs
  • ABAP 速查表 (/abap-cheat-sheets) - 32 份综合速查表涵盖核心 ABAP 概念、SQL、OOP、RAP 等
    📁 GitHub: SAP-samples/abap-cheat-sheets
  • ABAP RAP Fiori Elements 展示 (/abap-fiori-showcase) - 完整的注解参考,用于 ABAP RESTful 应用程序编程 (RAP)
    📁 GitHub: SAP-samples/abap-platform-fiori-feature-showcase
  • DSAG ABAP 指南 (/dsag-abap-leitfaden) - 德国 ABAP 社区的最佳实践和开发标准
    📁 GitHub: 1DSAG/ABAP-Leitfaden

🎨 UI5 开发来源

  • SAPUI5 文档 (/sapui5-docs) - 1,485+ 文件 - 完整的官方开发者指南、控件和最佳实践
    📁 GitHub: SAP-docs/sapui5
  • OpenUI5 框架 (/openui5) - 20,000+ 文件 - 完整的 OpenUI5 源代码,包括 500+ 控件 API 和详细的 JSDoc,以及 2,000+ 来自示例套件的工作示例
    📁 GitHub: SAP/openui5
  • UI5 TypeScript 集成 (/ui5-typescript) - 官方 TypeScript 设置指南、类型定义和迁移文档
    📁 GitHub: UI5/typescript
  • UI5 工具 (/ui5-tooling) - 完整的 UI5 工具文档,用于项目设置、构建和开发工作流
    📁 GitHub: SAP/ui5-tooling
  • UI5 Web 组件 (/ui5-webcomponents) - 4,500+ 文件 - 综合的 Web 组件文档、API 和实现示例
    📁 GitHub: SAP/ui5-webcomponents
  • UI5 自定义控件 (/ui5-cc-spreadsheetimporter) - 电子表格导入器和其他社区自定义控件文档
    📁 GitHub: spreadsheetimporter/ui5-cc-spreadsheetimporter