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開發提供全面支持。