SAP Documentation MCP Server

An MCP server that unifies official SAP docs (SAPUI5, CAP, OpenUI5 APIs & samples, wdi5) with real-time SAP Community content. Use it remotely (hosted URL) or run it locally and point your client to STDIO.

Public server: https://mcp-sap-docs.marianzeis.de/sse
Streamable HTTP (default: 3122, configurable via MCP_PORT): http://127.0.0.1:3122/mcp
(by default, both local and deployment use port 3122; override with MCP_PORT as needed)
Local HTTP status: http://127.0.0.1:3001/status
Proxy status (SSE gateway): http://127.0.0.1:18080/status

Quick start

Use the hosted server (recommended)

Point your MCP client to the SSE URL:

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

Verify from a shell:

# Should return JSON with api_last_activity
curl -sS https://mcp-sap-docs.marianzeis.de/status | jq .

# Should return an SSE line like: "event: endpoint" with a /messages path
curl -i -H 'Accept: text/event-stream' https://mcp-sap-docs.marianzeis.de/sse | head

Run it locally (STDIO + local HTTP status + Streamable HTTP)

# From repo root
npm ci
npm run build:index
npm run build

# Start the MCP server (STDIO)
node dist/src/server.js

# OR start the Streamable HTTP server (latest MCP spec)
npm run start:streamable

The companion HTTP status server runs (via PM2 in your setup) on 127.0.0.1:3001. The Streamable HTTP server runs on 127.0.0.1:3122 by default and supports the latest MCP protocol (2025-03-26). In the deployment, it is configured via MCP_PORT to 127.0.0.1:3122. The SSE proxy runs on 127.0.0.1:18080 and is what remote clients use.

Local health checks

# MCP proxy (SSE gateway)
curl -sS http://127.0.0.1:18080/status | jq .

# HTTP server
curl -sS http://127.0.0.1:3001/status | jq .

# Streamable HTTP server (local & deployment default)
curl -sS http://127.0.0.1:3122/health | jq .

What you get

sap_docs_search – unified search across SAPUI5/CAP/OpenUI5 APIs & samples, wdi5, and more
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_docs_get – fetches full documents/snippets with smart formatting
sap_help_get – retrieves complete SAP Help pages with metadata

Connect from your MCP client

✅ Remote URL: use the public SSE 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")

Remote (recommended) — add a custom connector

Open Claude Settings → Connectors → Add custom connector
Paste the URL:

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

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).

Local (STDIO) — add a local MCP server

Point Claude to the command and args:

command: node
args: ["<absolute-path-to-your-repo>/dist/src/server.js"]

Claude's user quickstart shows how to add local servers by specifying a command/args pair.

Local (Streamable HTTP) — latest MCP protocol

For the latest MCP protocol (2025-03-26) with Streamable HTTP support:

Start the streamable HTTP server:

npm run start:streamable

Add a custom connector with the URL:

http://127.0.0.1:3122/mcp

This provides better performance and supports the latest MCP features including session management and resumability.

Cursor

Remote (SSE URL)

Create or edit ~/.cursor/mcp.json:

{
  "mcpServers": {
    "sap-docs-remote": {
      "url": "https://mcp-sap-docs.marianzeis.de/sse"
    }
  }
}

Restart Cursor.

Local (STDIO)

~/.cursor/mcp.json:

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

Restart Cursor.

VS Code (GitHub Copilot Chat)

Add an MCP server

Open Copilot Chat → gear icon → MCP Servers → Add. You can add by command (local/STDIO), by URL (remote HTTP/SSE), or by local Streamable HTTP using the built-in wizard. Microsoft's "Add an MCP server" doc walks through this flow.

Remote (URL):

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

Local (command):

command: node
args: ["<absolute-path>/dist/src/server.js"]

Local (Streamable HTTP) - latest MCP protocol:

http://127.0.0.1:3122/mcp

(Start with npm run start:streamable first)

Zed Editor

Remote (URL server) & Local (Program server)

URL Server → add the SSE URL:

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

Program Server → point to:

command: node
args: ["<absolute-path>/dist/src/server.js"]

Zed's docs show how to add URL or Program MCP servers from Project → Settings → MCP Servers.

Windsurf

Remote & Local

Remote URL (SSE):

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

Local command:

node <absolute-path>/dist/src/server.js

Open Settings → Cascade → MCP and add a server (URL or Command).

LM Studio

Remote (URL) & Local (command)

Remote URL (SSE):

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

Local command:

node <absolute-path>/dist/src/server.js

In LM Studio, go to Program → Install → Edit mcp.json (or use their Add MCP Server flow). Then add either a url entry (remote) or command/args (local).

Goose (desktop & CLI)

Remote (SSE)

In Goose Settings → Extensions → Add custom extension:

Type: Remote Extension (SSE)
Endpoint:

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

(Goose docs show similar steps for adding remote MCP endpoints as "Remote Extension".)

Gemini CLI

Remote & Local

Add an MCP entry in your Gemini CLI settings (see their MCP guide), using either:

Remote URL:

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

Local command:

node <absolute-path>/dist/src/server.js

Features

🔍 Comprehensive Search System

sap_docs_search: Search official SAP documentation, APIs, sample code, and wdi5 docs
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
wdi5 E2E test framework docs - End-to-end testing documentation
Real-time community content - Live posts with engagement filtering

🌐 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
Quality Filtering: Only posts with kudos > 5 for high-quality content
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

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
Quality Assurance - Only posts with kudos > 5, automatically ranked by relevance
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

Use sap_docs_search with: "wdi5 configuration"

Returns: wdi5 documentation about configuration, setup, and usage.

Get Specific Documentation

Use sap_docs_get with: /wdi5

Returns: wdi5 documentation overview

Search SAP Community (with Full Content)

Use sap_community_search with: "wdi5 best practices"

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

Use sap_help_search with: "S/4HANA Fiori configuration"

Returns: Comprehensive SAP Help documentation about S/4HANA and Fiori configuration from help.sap.com.

Get SAP Help Content

Use sap_help_get with: sap-help-12345abc

Returns: Complete SAP Help page with full content and metadata.

Find Sample Implementations

Use sap_docs_search with: "button click handler"

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"

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"

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

Claude says it can't connect

Make sure the URL is the SSE URL: https://mcp-sap-docs.marianzeis.de/sse (not /messages, not /status).
Test SSE from your machine:

curl -i -H 'Accept: text/event-stream' https://mcp-sap-docs.marianzeis.de/sse | head

You should see event: endpoint and a /messages?... path. (This is the expected SSE handshake for remote MCP servers.)

VS Code wizard can't detect the server

Try adding it as URL first. If your network blocks SSE, use your local server via command:

node <absolute-path>/dist/src/server.js

Microsoft's "Add an MCP server" guide shows both URL and command flows.

Local server runs, but the client can't find it

Ensure you're pointing to the built entry:

node dist/src/server.js

If using PM2/systemd, confirm it's alive:

pm2 status mcp-sap-http
pm2 status mcp-sap-proxy
curl -fsS http://127.0.0.1:3001/status | jq .
curl -fsS http://127.0.0.1:18080/status | jq .

Development

Build Commands

npm run build        # Compile TypeScript
npm run build:index  # Build search index from sources
npm run build:fts    # Build FTS5 database
npm run test:community # Test community search functionality

Server Commands

npm start                  # Start STDIO MCP server
npm run start:http         # Start HTTP status server (port 3001)
npm run start:streamable   # Start Streamable HTTP MCP server (port 3122)

Local Setup

git clone https://github.com/marianfoo/mcp-sap-docs.git
cd mcp-sap-docs
./setup.sh           # Clone/update sources and build FTS
npm run build:index  # Build index.json
npm run build        # Compile TypeScript

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

# Check server status
curl -sS https://mcp-sap-docs.marianzeis.de/status | jq .

# Test SSE connection
curl -i -H 'Accept: text/event-stream' https://mcp-sap-docs.marianzeis.de/sse | head

Local Endpoints

# HTTP server status
curl -sS http://127.0.0.1:3001/status | jq .

# SSE proxy status  
curl -sS http://127.0.0.1:18080/status | jq .

Deployment

Automated Workflows

This project includes dual automated workflows:

Main Deployment (on push to main)
- SSH into server and pull latest code + submodules
- Update documentation sources and rebuild indices
- Restart services with health checks
Daily Documentation Updates (4 AM UTC)
- Update all documentation submodules to latest versions
- Rebuild search indices with fresh content
- 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 2025-03-26) - HTTP-based transport with session management and resumability
SSE Proxy (Python) - Bridges STDIO → URL for remote clients
Reverse Proxy (Caddy) - TLS termination and routing
Search Engine - SQLite FTS5 + JSON indices for fast local search
Community Integration - HTML scraping + LiQL API for full content retrieval
SAP Help Integration - Private API access to help.sap.com content

Project Statistics

Total Files: 4,180+ documentation files + real-time community & help portal content
SAPUI5 Docs: 1,485 markdown files
CAP Docs: 195 markdown files
OpenUI5 APIs: 500+ JavaScript control definitions
Sample Code: 2,000+ implementation examples
Community Posts: Real-time access with full content delivery (top 3 results)
SAP Help Portal: Comprehensive access to all SAP product documentation
Search Database: 8+ MB FTS5 database with 14,822+ indexed documents
Search Coverage: Official docs + community + help portal = complete SAP ecosystem

License

MIT

Name		Name	Last commit message	Last commit date
Latest commit History 29 Commits
.github/workflows		.github/workflows
.vscode		.vscode
docs		docs
scripts		scripts
sources		sources
src		src
test		test
.gitattributes		.gitattributes
.gitignore		.gitignore
.gitmodules		.gitmodules
LICENSE		LICENSE
README.md		README.md
REMOTE_SETUP.md		REMOTE_SETUP.md
check-reduction.ts		check-reduction.ts
documentation.md		documentation.md
ecosystem.config.cjs		ecosystem.config.cjs
package-lock.json		package-lock.json
package.json		package.json
setup.sh		setup.sh
test-community-search.js		test-community-search.js
test-search-interactive.ts		test-search-interactive.ts
test-search.http		test-search.http
test-search.ts		test-search.ts
tsconfig.json		tsconfig.json

License

marianfoo/mcp-sap-docs

Folders and files

Latest commit

History

Repository files navigation

SAP Documentation MCP Server

Quick start

What you get

Connect from your MCP client

Claude (Desktop / Web "Connectors")

Cursor

VS Code (GitHub Copilot Chat)

Zed Editor

Windsurf

LM Studio

Goose (desktop & CLI)

Gemini CLI

Features

🔍 Comprehensive Search System

📚 Comprehensive Coverage

🌐 SAP Community Integration

🏢 SAP Help Portal Integration

💡 Smart Features

What's Included

Official Documentation

Community Content (Full Content Included)

SAP Help Portal Content

Usage Examples

Search Official Documentation

Get Specific Documentation

Search SAP Community (with Full Content)

Search SAP Help Portal

Get SAP Help Content

Find Sample Implementations

Example Prompts

Troubleshooting

Development

Build Commands

Server Commands

Local Setup

Health & Status Monitoring

Public Endpoints

Local Endpoints

Deployment

Automated Workflows

Manual Updates

Architecture

Project Statistics

License

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Contributors 3

Languages

Packages