MCP Sap Docs

🚀 SAP文档MCP服务器

这是一个全面的模型上下文协议（MCP）服务器，提供离线访问SAP文档和实时获取SAP社区内容的功能。该服务器将官方文档与社区驱动的解决方案集成在一起，使开发人员既能访问权威文档，又能获取来自SAP社区的实际、真实的见解。

✨ 主要特性

• 🔍 双搜索系统：
  • sap_docs_search：搜索官方SAP文档、API、示例代码和wdi5文档。
  • sap_community_search：搜索实时的SAP社区内容。
• 📚 全面覆盖：涵盖1485 + 份SAPUI5文件、195 + 份CAP文件、500 + 个OpenUI5 API、2000 + 份示例文件、wdi5端到端测试框架文档，以及实时的社区内容。
• 🌐 SAP社区集成：提供专门的工具，用于搜索高质量的社区博客文章、解决方案和讨论。
• 💡 智能格式化：自动进行代码高亮显示、示例分类和内容格式化。
• 🔄 实时内容：社区帖子实时获取，并通过参与度过滤（点赞数 > 5）。
• 🎯 特定来源结果：可根据需求在官方文档和社区经验之间进行选择。

📦 安装指南

1. 克隆并安装依赖项：

   git clone <repository-url>
   cd sap-docs-mcp
   npm install
   

2. 下载并准备文档源：

   chmod +x setup.sh
   ./setup.sh
   

3. 构建搜索索引：

   npm run build-index
   

4. 构建服务器：

   npm run build
   

📚 详细文档

官方文档

• SAPUI5文档：包含完整的开发人员指南，有1485 + 份文件。
• CAP文档：云应用程序编程模型，有195 + 份文件。
• OpenUI5 API文档：500 + 个控件API，带有详细的JSDoc注释。
• OpenUI5示例代码：来自demokit/sample目录的2000 + 个可用示例。
• wdi5文档：来自[wdi5](https://github.com/ui5 - community/wdi5) (/wdi5)的端到端测试框架文档。

社区内容

• 博客文章：来自SAP社区的技术教程和深度剖析。
• 解决方案：针对常见开发问题的实际解决方案。
• 最佳实践：经过社区测试的方法和模式。
• 代码示例：开发人员分享的实际实现。
• 高质量过滤：仅显示点赞数 > 5的帖子以确保质量。

配置

在你的Cursor settings.json中添加以下内容：

{
  "mcpServers": {
    "sap-docs": {
      "command": "node",
      "args": ["/path/to/sap-docs-mcp/dist/index.js"]
    }
  }
}

可用库

1. /sapui5 - SAPUI5开发人员文档（1485份文件）
2. /cap - CAP文档（195份文件）
3. /openui5-api - OpenUI5控件API（500 + 个控件）
4. /openui5-samples - OpenUI5示例代码（2000 + 个示例）
5. /wdi5 - wdi5端到端测试框架文档
6. /community - SAP社区帖子（实时）

💻 使用示例

基础用法

搜索官方文档

使用 sap_docs_search 搜索："wdi5 configuration"

返回结果：关于wdi5配置、设置和使用的文档。

获取wdi5文档

使用 sap_docs_get 获取：/wdi5

返回结果：wdi5文档概述。

搜索wdi5主题

使用 sap_docs_search 搜索："wdi5 cli"

返回结果：wdi5 CLI文档和相关指南。

搜索SAP社区

使用 sap_community_search 搜索："wdi5 best practices"

返回结果：关于wdi5最佳实践的近期社区帖子、博客文章和讨论。

获取特定文档

使用 sap_docs_get 获取：/sapui5

返回结果：SAPUI5文档概述。

获取社区见解

使用 sap_docs_get 获取：community-12345

返回结果：带有元数据的特定社区帖子的完整内容。

查找示例实现

使用 sap_docs_search 搜索："button click handler"

返回结果：

• 官方按钮文档
• 带有JS控制器的示例按钮实现
• XML视图示例

高级用法

官方文档搜索测试用例

工具：sap_docs_search 查询："wdi5" 预期结果：

• wdi5文档概述
• wdi5指南和API参考
• wdi5使用和配置示例

社区内容搜索测试用例

工具：sap_community_search 查询："wdi5" 预期结果：

• 关于wdi5的社区博客文章
• 实际开发人员的解决方案和代码示例
• 关于wdi5最佳实践的讨论线程

示例代码发现测试用例

工具：sap_docs_search 查询："data binding" 预期结果：

• 官方数据绑定文档
• 带有模型和绑定的可用示例代码
• 示例实现中的实际示例

社区最佳实践测试用例

工具：sap_community_search 查询："authentication best practices" 预期结果：

• 关于身份验证实现的社区博客文章
• 实际开发人员的解决方案和代码示例
• 关于常见身份验证问题的讨论线程

🔧 技术细节

项目统计

• 总文件数：4180 + 份文档文件 + 实时社区内容
• SAPUI5文档：1485份Markdown文件
• CAP文档：195份Markdown文件
• OpenUI5 API：500 + 个JavaScript控件定义
• 示例代码：2000 + 个实现示例
• 社区帖子：实时访问经过过滤的高质量内容
• 总搜索索引：动态的，将离线文档与实时社区数据相结合

社区集成详情

SAP社区集成使用官方SAP社区API来获取：

• 来自SAPUI5和CAP产品领域的博客文章
• 高参与度内容（点赞数 > 5的帖子）
• 按发布时间排序的近期讨论
• 包括代码示例和解决方案的完整帖子内容

社区内容实时获取，确保你始终能获得来自SAP开发社区的最新见解和解决方案。

架构

此MCP服务器使用资源而非工具，使Cursor能够：

• 浏览可用的文档库
• 同时搜索所有内容类型
• 访问特定文档和社区帖子
• 在官方文档旁边获取实时社区见解
• 获取格式正确且有上下文的示例代码

服务器智能地将离线文档与实时社区内容相结合，为SAP开发提供全面的知识库。

开发

• 构建：npm run build
• 构建索引：npm run build-index
• 类型检查：npm run type-check

构建过程会创建优化的搜索索引，以实现快速离线访问，同时保持与SAP社区API的实时连接，以获取最新的社区内容。

此MCP服务器弥合了官方SAP文档、wdi5端到端测试框架文档与实际开发人员知识之间的差距，通过权威来源和社区智慧为SAP开发提供全面支持。