Mcp Sap Docs

MCP SAP Docs (Upstream)

An MCP server that gives AI assistants (Claude, Cursor, ChatGPT, etc.) access to SAP documentation through a unified search and fetch interface. It combines local full-text search and optional semantic ranking over git-cloned SAP docs with optional live queries to SAP Help, SAP Community, and Software Heroes — all exposed as MCP tools.

Install

[Add to Werkbank]

Or add it to any MCP client that supports streamable HTTP:

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

No API key or login required — the server is public and read-only.

Public Hosted Endpoint

Ready to use — no setup required

Variant	URL
SAP Docs	http://mcp-sap-docs.marianzeis.de/mcp
ABAP	https://mcp-abap.marianzeis.de/mcp

Variants

mcp-sap-docs is the upstream repository for two MCP server variants that share one codebase and differ by configuration (MCP_VARIANT / .mcp-variant):

Documentation Sources

Offline sources (local index, always available)

Additional SAP Docs sources

The sap-docs profile also indexes the following official documentation. These sources use the existing Markdown/MDX pipeline and link to their upstream files.

Integration Suite indexes docs/ISuite_Integrations_APIs and docs/ISuite_Event_Mesh. Parallel Cloud Integration/API Management guide copies are excluded to avoid repeated content and mixed navigation terminology. Python SDK sources include current docs-python content; historical version folders are excluded.

SAP-docs repositories carry CC-BY-4.0 notices; SAP Cloud SDK, AI SDK, and OData vocabularies carry Apache-2.0 notices. The source checkouts retain their upstream license files, and search/fetch results link to the original documents. See source expansion plan for validation and scope.

Online sources (live queries, enabled by default)

Available Tools

Shared tools (both variants)

sap-docs variant only

abap variant only

Architecture Overview

• Upstream source of truth: mcp-sap-docs
• One-way sync target: abap-mcp-server
• Search defaults to BM25 keyword ranking; optional semantic scores are combined via Reciprocal Rank Fusion (RRF)
• Embeddings model: Xenova/all-MiniLM-L6-v2 (~90 MB, cached in dist/models/)

Variant Selection

Resolution order:

1. MCP_VARIANT environment variable
2. .mcp-variant file in repo root
3. fallback: sap-docs

Examples:

# Run as full sap-docs profileMCP_VARIANT=sap-docs npm run setupMCP_VARIANT=sap-docs npm run buildMCP_VARIANT=sap-docs npm run start:streamable
# Run as ABAP profileMCP_VARIANT=abap npm run setupMCP_VARIANT=abap npm run buildMCP_VARIANT=abap npm run start:streamable

Search Behavior

search performs fused retrieval over:

• Offline FTS index (local submodule content)
• Optional online sources (includeOnline=true):
  • SAP Help
  • SAP Community
  • Software Heroes content search (EN/DE merge + dedupe)

Ranking and filtering highlights:

• BM25 search with optional semantic ranking — keyword and meaning, fused via RRF
• Reciprocal Rank Fusion (RRF) across offline and online sources
• Source-level boosts from metadata
• includeSamples can remove sample-heavy sources
• abapFlavor (standard / cloud / auto) filters official ABAP docs libraries while keeping non-ABAP sources
• sources can restrict offline libraries explicitly

Fetch content limits

Community post bodies are returned as Markdown, including code, links, images and tables. Clients that previously parsed raw Community HTML must consume Markdown. Document IDs, source URLs and response schemas are unchanged. If conversion fails, that post keeps its original HTML with a notice; other posts in the same batch are still returned.

SAP Help and Community fetches default to 75,000 characters. Shortened results include metadata.truncation with exact loss counts. Self-hosted servers can set MAX_CONTENT_LENGTH before startup; see content size limits.

Hybrid Search

Offline search defaults to BM25 keyword ranking. Optional semantic ranking uses Xenova/all-MiniLM-L6-v2 to reorder the lexical candidates; it does not search outside that candidate pool. Enable it explicitly with EMBEDDING_WEIGHT=0.7 after building complete document and section embeddings and evaluating your own queries.

Embeddings are stored in docs.sqlite, with the model cached in dist/models/. Old or partial embedding artifacts fall back to lexical ranking with a rebuild warning. See docs/HYBRID-SEARCH.md for setup, limitations and costs.

Offline-Only Mode

search includes online sources by default. To run offline-only, use:

• local index/submodules only (npm run setup + npm run build)
• includeOnline=false in each search request

Example search request body:

{  "query": "RAP draft",  "k": 8,  "includeOnline": false}

Docker (offline-only)

Run the container with host binding and call search with includeOnline=false:

docker run --rm -p 3122:3122 \  -e MCP_VARIANT=sap-docs \  -e MCP_PORT=3122 \  -e MCP_HOST=0.0.0.0 \  mcp-sap-docs

For strict air-gapped execution, disable container networking:

docker run --rm --network none -p 3122:3122 \  -e MCP_VARIANT=sap-docs \  -e MCP_PORT=3122 \  -e MCP_HOST=0.0.0.0 \  mcp-sap-docs

Notes:

• With --network none, online fetches are impossible by runtime isolation.
• Startup may log warnings for online prefetch attempts (for example ABAP feature matrix); this does not prevent offline search usage.

Quick Start (Local)

npm cinpm run setupnpm run build

npm run setup updates the selected variant's documentation sources to their configured branch tips and builds the index, including embeddings. Nested submodules stay at the commits recorded by those sources. To omit optional nested repositories (for example when their upstream URLs require SSH credentials), use SKIP_NESTED_SUBMODULES=1 npm run setup in Bash, including Git Bash on Windows.

npm run setup:submodules instead checks out the repository's recorded source commits. It does not fetch the latest documentation or apply variant filtering. Run npm run setup when refreshing an existing installation.

Start server modes:

# MCP stdionpm start
# HTTP status/dev servernpm run start:http
# MCP streamable HTTPnpm run start:streamable

Default ports by variant:

• sap-docs: HTTP 3001, streamable 3122
• abap: HTTP 3002, streamable 3124

Health checks:

curl -sS http://127.0.0.1:3122/health | jq .curl -sS http://127.0.0.1:3001/status | jq .

Use variant-specific ports when running abap profile.

Build and Setup Scripts

Script names remain shared (setup, build, start, start:streamable). Behavior changes by variant config:

• setup.sh only initializes variant-allowed submodules
• build-index only includes variant-allowed libraries
• build-fts only indexes variant-allowed libraries

This keeps abap faster and smaller without maintaining a separate build script set.

Docker

Build image for a variant:

# sap-docs imagedocker build --build-arg MCP_VARIANT=sap-docs -t mcp-sap-docs .
# abap imagedocker build --build-arg MCP_VARIANT=abap -t abap-mcp-server .

Run streamable server:

# sap-docsdocker run --rm -p 3122:3122 \  -e MCP_VARIANT=sap-docs \  -e MCP_PORT=3122 \  mcp-sap-docs
# abapdocker run --rm -p 3124:3124 \  -e MCP_VARIANT=abap \  -e MCP_PORT=3124 \  abap-mcp-server

SAP BTP Cloud Foundry

For BTP CF, the recommended sap-docs path is to deploy the maintained ghcr.io/marianfoo/mcp-sap-docs:sap-docs image with MTA. Cloud Foundry only pulls and runs the prepared image, including embedding artifacts. Ranking remains lexical unless a positive EMBEDDING_WEIGHT is explicitly configured.

See docs/BTP-CF-DEPLOYMENT.md for the public-first deployment guide. Start with Deployment Options and Tradeoffs to choose between MTA, direct cf push, custom registry images, and refresh setup.

One-Way Sync to abap-mcp-server

This repository contains direct sync automation:

• Workflow: .github/workflows/sync-to-abap-main.yml
• Script: scripts/sync-to-abap.sh

Flow:

1. Release Please publishes a release in mcp-sap-docs after its release PR is merged
2. The release workflow explicitly dispatches the ABAP sync workflow
3. The sync workflow clones abap-mcp-server
4. Tracked upstream files are synced (with exclude rules), then the ABAP overlay is applied
5. .mcp-variant is forced to abap and ABAP package identity is patched
6. A sync commit is pushed to abap-mcp-server/main
7. That push triggers the ABAP deployment workflow

The sync workflow also supports manual runs, including dry runs and a custom target branch. Only pushes to the downstream main branch trigger automatic deployment.

Required secret in mcp-sap-docs repo:

• ABAP_REPO_SYNC_TOKEN: a dedicated token with access to push code and workflow changes to abap-mcp-server. Keep this separate from GITHUB_TOKEN, whose pushes do not trigger subsequent workflows.

Deployment Model

• mcp-sap-docs: owns release versions and dispatches its deployment and ABAP sync when a release is created
• abap-mcp-server: deploys on pushes to main, including upstream sync commits, or via workflow_dispatch

The downstream repository does not publish GitHub releases. Its deployment must therefore listen for sync pushes, not release: published. Upstream releases control when automatic syncs occur.

The ABAP deployment workflow is maintained in sync/abap.overlay/.github/workflows/deploy-abap-mcp-server.yml. Change that upstream overlay so the fix persists across future syncs.

After merging a deployment fix, publish the next upstream release or manually run sync-to-abap-main.yml against upstream main. Confirm that the downstream deploy run succeeds and that https://mcp-abap.marianzeis.de/health reports the version in the synced ABAP package.json; a successful sync alone does not confirm deployment.

PM2 Runtime

ecosystem.config.cjs is variant-aware and resolves:

• process names
• ports
• deploy path

from config/variants/*.json.

Validation Commands

npm run build:tscnpm run test:url-generationnpm run test:integrationnpm run test:software-heroesnpm run test:discovery-center # mocked Discovery Center REST contract testsnpm run test:discovery-center:live # opt-in live API smoke testnpm run test:sap-objects       # SAP Released Objects unit tests
# Variant-specific build checksMCP_VARIANT=sap-docs npm run build:indexMCP_VARIANT=abap npm run build:indexMCP_VARIANT=sap-docs npm run build:ftsMCP_VARIANT=abap npm run build:fts

Additional Docs

• docs/ARCHITECTURE.md
• docs/DEV.md
• docs/TESTS.md
• docs/UPSTREAM-ONE-WAY-SYNC-IMPLEMENTATION.md
• REMOTE_SETUP.md

Curated SAP tutorials

The SAP Docs profile includes 32 additional official tutorials in sap-tutorials-ai, sap-tutorials-hana, and sap-tutorials-integration: AI Core orchestration V2 and grounding, HANA Cloud SQLScript and CAP, Integration Suite MCP Gateway, and Cloud Transport Management. The existing Fiori OPA guide is still available separately.

Use product and task terms, for example SAP HANA Cloud SQLScript stored procedure tutorial or SAP Integration Suite MCP Gateway tutorial. Use sources to narrow an ambiguous search; leave it unset for cross-source discovery. Tutorials provide worked examples and retain their prerequisites; product and SDK documentation remain the reference for detailed API behavior.

The explicit selection is in config/tutorials.json. Fetched tutorials include readable option labels, absolute asset/prerequisite links, and their published page URL. The unpublished transport overview links to its official GitHub source. Source content and its original attribution are preserved; the original tutorial repository's license still applies.