The SAP Documentation MCP Server provides unified access to official SAP documentation, real-time SAP Community content, and SAP Help Portal resources for comprehensive SAP development support.
Core Capabilities:
Search SAP Documentation (
sap_docs_search
): Query SAPUI5, CAP, OpenUI5 APIs, and wdi5 documentation for controls, technical concepts, and development topicsSearch SAP Community (
sap_community_search
): Find high-quality blog posts and solutions with real-time access and automatic full content retrieval for top resultsSearch SAP Help Portal (
sap_help_search
): Access comprehensive SAP product documentation across S/4HANA, SAP BTP, Analytics Cloud, Fiori, and ABAPRetrieve Specific Content (
sap_docs_get
,sap_help_get
): Fetch detailed documentation, control APIs, or community posts using unique IDs with optional filtering
Content Coverage: Over 4,180+ documentation files including SAPUI5 (1,485+ files), CAP (195+ files), OpenUI5 APIs (500+ definitions), 2,000+ sample code examples, plus real-time community posts and full SAP Help Portal access.
Smart Features: Intelligent search with context-aware scoring, automatic code highlighting, quality filtering, and sample categorization.
Access Methods: Remote via public SSE endpoint or local via STDIO/HTTP server, compatible with popular MCP clients like Claude, VS Code, Cursor, Zed Editor, Windsurf, and others.
Provides offline access to SAP documentation and real-time SAP Community content, including SAPUI5, CAP, OpenUI5 APIs and samples, and wdi5 E2E test framework documentation. Enables searching across official documentation and community posts, retrieving specific resources, and accessing high-quality community solutions.
SAP Documentation MCP Server
A fast, lightweight MCP server that provides unified access to official SAP documentation (SAPUI5, CAP, OpenUI5 APIs & samples, wdi5) using efficient BM25 full-text search. Use it remotely (hosted URL) or run it locally and point your client to STDIO.
Public server STDIO: https://mcp-sap-docs.marianzeis.de/sse
Public server Streamable HTTP: https://mcp-sap-docs.marianzeis.de/mcp
Streamable HTTP (default: 3122, configurable via MCP_PORT): http://127.0.0.1:3122/mcp
Local HTTP status: http://127.0.0.1:3001/status
Proxy status (SSE gateway): http://127.0.0.1:18080/status
Quick start
Point your MCP client to the SSE URL:
or the Streamable HTTP URL:
Verify from a shell:
Local health checks
What you get
- sap_docs_search – unified search across all SAP documentation sources including 40,761+ curated ABAP files across 8 versions with intelligent version auto-detection and filtering. Shows latest ABAP by default; specific versions only when requested (e.g., "LOOP 7.57" shows only ABAP 7.57 + related sources)
- sap_docs_get – fetches complete documents/snippets with smart formatting for all sources including ABAP
- sap_community_search – real-time SAP Community posts with full content of top 3 results
- sap_help_search – comprehensive search across all SAP Help Portal documentation
- sap_help_get – retrieves complete SAP Help pages with metadata
Connect from your MCP client
✅ Remote URL: use the public SSE endpoint or Streamable HTTP endpoint
✅ Local/STDIO: run node dist/src/server.js
and point the client to a command + args
✅ Local/Streamable HTTP: run npm run start:streamable
and point the client to http://127.0.0.1:3122/mcp
Below are copy-paste setups for popular clients. Each block has remote, local, and streamable HTTP options.
Claude (Desktop / Web "Connectors")
- Open Claude Settings → Connectors → Add custom connector
- Paste the URL:
- Save; Claude will perform the SSE handshake and obtain the /messages endpoint automatically.
(Claude documents the Remote MCP flow for SSE connectors here.)
Docs: Model Context Protocol "Connect to Remote MCP Servers" (shows how Claude connects to SSE).
Point Claude to the command and args:
Claude's user quickstart shows how to add local servers by specifying a command/args pair.
For the latest MCP protocol (2025-03-26) with Streamable HTTP support:
- Start the streamable HTTP server:
- Add a custom connector with the URL:
This provides better performance and supports the latest MCP features including session management and resumability.
Cursor
Create or edit ~/.cursor/mcp.json
:
~/.cursor/mcp.json
:
Eclipse (GitHub Copilot)
Eclipse users can integrate the SAP Docs MCP server with GitHub Copilot for seamless access to SAP development documentation.
⚠️ Important Limitation: GitHub Copilot did not support Eclipse ADT (ABAP Development Tools) due to the
semanticfs
URI scheme used for ABAP development. See GitHub Issue #171406 for details.Workaround: Make sure your Copilot Version in Eclipse is up to date to make it work!
Prerequisites
- Eclipse Version: 2024-09 or higher
- GitHub Copilot Extension: Latest version from Eclipse Marketplace
- GitHub Account: With Copilot access
- Note: Full ABAP ADT integration is not yet supported
Configuration Steps
- Install GitHub Copilot Extension
- Download from Eclipse Marketplace
- Follow the installation instructions
- Open MCP Configuration
- Click the Copilot icon (🤖) in the Eclipse status bar
- Select "Edit preferences" from the menu
- Expand "Copilot Chat" in the left panel
- Click on "MCP"
- Add SAP Docs MCP Server
- Verify Configuration
- The server should appear in your MCP servers list
- Status should show as "Connected" when active
Using SAP Docs in Eclipse
Once configured, you can use Copilot Chat in Eclipse with enhanced SAP documentation:
Example queries:
Available Tools:
sap_docs_search
- Unified search for all SAP development (UI5, CAP, ABAP, testing) with intelligent ABAP version filteringsap_community_search
- SAP Community integrationsap_help_search
- SAP Help Portal accesssap_docs_get
- Retrieve complete documentation for any source
Local MCP Server Configuration
Prerequisites for local setup:
- Clone and build this repository locally
- Run
npm run setup
to initialize all documentation sources - Ensure the server starts correctly with
npm start
VS Code (GitHub Copilot Chat)
Prerequisites: VS Code 1.102+ with MCP support enabled (enabled by default).
Quick Setup
Create .vscode/mcp.json
in your workspace:
Alternative (SSE): Use "type": "sse"
with "url": "https://mcp-sap-docs.marianzeis.de/sse"
if HTTP doesn't work.
Using the Remote Server
- Save the
.vscode/mcp.json
file in your workspace - VS Code will automatically detect and start the MCP server
- Open Chat view and select Agent mode
- Click Tools button to see available SAP documentation tools
- Ask questions like "How do I implement authentication in SAPUI5?"
Benefits:
- ✅ No local installation required
- ✅ Always up-to-date documentation
- ✅ Automatic updates and maintenance
- ✅ Works across all your projects
Note: You'll be prompted to trust the remote MCP server when connecting for the first time.
Local STDIO Server
Local HTTP Server
(Start local server with npm run start:streamable
first)
Alternative Setup Methods
- Command Palette: Run
MCP: Add Server
→ choose server type → provide details → select scope - User Configuration: Run
MCP: Open User Configuration
for global setup across all workspaces
See Microsoft's "Use MCP servers in VS Code" for complete documentation.
Raycast
Open Raycast → Open Command "Manage Servers (MCP) → Import following JSON
Open Raycast → Open Command "Manage Servers (MCP) → Import following JSON
Raycast by default asks to confirm each usage of an MCP tool. You can enable automatic confirmation:
Open Raycast → Raycast Settings → AI → Model Context Protocol → Check "Automatically confirm all tool calls"
Features
🔍 Comprehensive Search System
- sap_docs_search: Unified search across all SAP documentation including 40,761+ curated ABAP files across 8 versions (7.52-7.58 + latest) with intelligent version filtering - shows latest by default, specific versions only when requested
- sap_community_search: Search real-time SAP Community content with automatic full content retrieval of top 3 posts
- sap_help_search: Search SAP Help Portal using private APIs for all SAP product documentation across S/4HANA, BTP, Analytics Cloud, and more
📚 Comprehensive Coverage
- 1,485+ SAPUI5 files - Complete developer guide
- 195+ CAP files - Cloud Application Programming model
- 500+ OpenUI5 APIs - Control APIs with detailed JSDoc
- 2,000+ sample files - Working examples from
demokit/sample
directories - 40,761+ curated ABAP files - Official SAP ABAP keyword documentation across 8 versions with intelligent version filtering (latest by default, specific versions when requested)
- wdi5 E2E test framework docs - End-to-end testing documentation
- UI5 TypeScript documentation - Official TypeScript integration guides and type definitions
- ABAP best practices - Clean ABAP guidelines, cheat sheets, and German community guidelines (DSAG)
- Fiori Elements showcases - Comprehensive annotation references for both ABAP RAP and CAP
- Real-time community content - Live posts with engagement info
- UI5 Tooling docs - UI5 Tooling documentation
- Cloud MTA Build Tool docs - Cloud MTA Build Tool Documentation
- UI5 Web Components docs - UI5 Web Components documentation
- UI5 Custom Controls - Spreadsheet importer and other custom control documentation
- SAP Cloud SDK - SAP Cloud SDK documentation (Javascript & Java)
- SAP Cloud SDK for AI - SAP Cloud SDK for AI documentation (Javascript & Java)
🌐 SAP Community Integration
- Intelligent Search: HTML scraping using SAP Community's "Best Match" algorithm
- Full Content Delivery: Automatic retrieval of complete blog post content for top 3 results
- Engagement Info: Includes kudos count when available (no hard kudos filtering)
- Efficient API Usage: Batch content retrieval using LiQL API for fast response times
- Real-world Knowledge: Live posts with practical developer insights and solutions
🏢 SAP Help Portal Integration
- Comprehensive Coverage: Search across all SAP product documentation
- Private API Access: Direct integration with help.sap.com internal APIs
- Full Content Retrieval: Complete documentation pages with metadata
- Product Scope: S/4HANA, SAP BTP, Analytics Cloud, Fiori, ABAP, and more
💡 Smart Features
- Automatic code highlighting and sample categorization
- Context-aware search with intelligent scoring
- Source-specific results for targeted searches
What's Included
Official Documentation
- SAPUI5 Documentation (
/sapui5
) - Complete developer guide with 1,485+ files - CAP Documentation (
/cap
) - Cloud Application Programming model with 195+ files - OpenUI5 API Documentation (
/openui5-api
) - 500+ control APIs with detailed JSDoc - OpenUI5 Sample Code (
/openui5-samples
) - 2,000+ working examples - wdi5 Documentation (
/wdi5
) - End-to-end test framework documentation - UI5 Tooling Documentation (
/ui5-tooling
) - UI5 Tooling documentation - Cloud MTA Build Tool Documentation (
/cloud-mta-build-tool
) - Cloud MTA Build Tool documentation - UI5 Web Components Documentation (
/ui5-webcomponents
) - UI5 Web Components documentation
Community Content (Full Content Included)
- Complete Blog Posts - Full technical tutorials and deep-dives with complete content
- Real-world Solutions - Comprehensive answers to development problems with full context
- Best Practices - Community-tested approaches with detailed explanations
- Code Examples - Complete implementations with full source code and explanations
- Engagement Info - Displays kudos when available; results follow Best Match ranking
- Instant Access - Top 3 results include full post content (no additional API calls needed)
SAP Help Portal Content
- Product Documentation - Complete guides for S/4HANA, BTP, Analytics Cloud
- Implementation Guides - Step-by-step setup and configuration documentation
- Technical References - API documentation, development guides, and technical specs
- Troubleshooting - Comprehensive problem-solving documentation
- Release Notes - Latest updates and changes across SAP products
Usage Examples
Search Official Documentation
Returns: wdi5 documentation about configuration, setup, and usage.
Get Specific Documentation
Returns: wdi5 documentation overview
Search SAP Community (with Full Content)
Returns: Top 3 most relevant community posts about wdi5 best practices with complete blog post content included - no need for additional API calls.
Search SAP Help Portal
Returns: Comprehensive SAP Help documentation about S/4HANA and Fiori configuration from help.sap.com.
Get SAP Help Content
Returns: Complete SAP Help page with full content and metadata.
Find Sample Implementations
Returns:
- Official button documentation
- Sample button implementations with JS controllers
- XML view examples
Example Prompts
Try these with any connected MCP client:
Official Documentation:
- "How do I implement authentication in SAPUI5?"
- "Show me wdi5 testing examples for forms"
- "Find OpenUI5 button control examples with click handlers"
- "What is Clean ABAP and how do I follow the style guide?"
- "Show me TypeScript setup for UI5 development"
ABAP Keyword Documentation (Enhanced):
- "What is the syntax for inline declarations in ABAP 7.58?"
- "How do I use SELECT statements with internal tables?"
- "Show me exception handling with TRY-CATCH in ABAP"
- "What are the differences between LOOP and WHILE in ABAP?"
- "How do I define classes and methods in ABAP OOP?"
Community Knowledge (with full content):
- "What are the latest CAP authentication best practices from the community?"
- "Find community examples of OData batch operations with complete implementation"
- "Search for temporal data handling in CAP with real-world solutions"
- "Find RAP development tips and tricks from the community"
SAP Help Portal:
- "How to configure S/4HANA Fiori Launchpad?"
- "Find BTP integration documentation for Analytics Cloud"
- "Search for ABAP development best practices in S/4HANA"
Troubleshooting
- Make sure the URL is the SSE URL:
https://mcp-sap-docs.marianzeis.de/sse
(not /messages, not /status). - Test SSE from your machine:
You should see event: endpoint
and a /messages?...
path. (This is the expected SSE handshake for remote MCP servers.)
- Try adding it as URL first. If your network blocks SSE, use your local server via command:
- Microsoft's "Add an MCP server" guide shows both URL and command flows.
- Ensure you're pointing to the built entry:
- If using PM2/systemd, confirm it's alive:
Development
Build Commands
Server Commands
Local Setup
The build process creates optimized search indices for fast offline access while maintaining real-time connectivity to the SAP Community API.
Health & Status Monitoring
Public Endpoints
Local Endpoints
Deployment
Automated Workflows
This project includes dual automated workflows:
- Main Deployment (on push to
main
or manual trigger)- SSH into server and pull latest code
- Run enhanced setup with optimized submodule handling
- Restart all PM2 processes (proxy, http, streamable) with health checks
- Daily Documentation Updates (4 AM UTC)
- Update all documentation submodules to latest versions
- Rebuild search indices with fresh content using enhanced setup
- Restart services automatically
Manual Updates
Trigger documentation updates anytime via GitHub Actions → "Update Documentation Submodules" workflow.
Architecture
- MCP Server (Node.js/TypeScript) - Exposes Resources/Tools for SAP docs, community & help portal
- Streamable HTTP Transport (Latest MCP spec) - HTTP-based transport with session management and resumability
- SSE Proxy (Python) - Bridges STDIO → URL for remote clients
- BM25 Search Engine - SQLite FTS5 with optimized OR-logic queries for fast, relevant results
- Optimized Submodules - Shallow, single-branch clones with blob filtering for minimal bandwidth
Search Implementation
The server uses a BM25-only approach for optimal performance:
- SQLite FTS5 - Full-text search with prefix matching and OR logic
- Query Processing - Automatic stopword filtering and phrase detection
- Fast Response Times - ~15ms average query time
- High Recall - OR logic ensures comprehensive results
- Lightweight - No external dependencies or ML models required
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Provides offline access to SAP documentation and real-time SAP Community content, integrating official documentation with community-driven solutions for comprehensive developer support.
Related MCP Servers
- -securityAlicense-qualityServes as a guardian of development knowledge, providing AI assistants with curated access to latest documentation and best practices.Last updated -8374MIT License
- AsecurityFlicenseAqualityScrape documentation for libraries and API'sLast updated -11
- -securityAlicense-qualityProvides access to personal/team knowledge repositories with tools to search, retrieve, and save information from various sources including Slack, Gmail, and document storage platforms.Last updated -Apache 2.0
- -securityFlicense-qualityDirect access to the Revit API docs and related content.Last updated -5