PackagePackagetypeA library you install and call yourself.See every one →What this type is →by SAPby SAPoriginPublished by SAP itself. A visible facet, never an input to a reading — a dormant official plugin reads exactly like a dormant independent one.See every one →
@sap-ux/fiori-docs-embeddings
Fiori documentation indexed as embeddings, which is what makes it searchable by something other than a person scrolling it.
DocumentationCAPDocumentationcapabilityFinding the answer in what has already been written, and writing it where it has not — first-party documentation made searchable by something other than a person scrolling it, including by an agent, and a document of custom code produced from the code itself.
Who is behind it
SAPSAPOrganisationMaintains this In the atlas: maintains 137, wrote 14@SAPmaintainerAndis RedmansPersonContributes to this In the atlas: contributes to 13@815areAisling NoonePersonContributes to this In the atlas: contributes to 8@aislingnooneAlina GovoruhinaPersonContributes to this In the atlas: contributes to 9@AlinaGovoruhinaArtemis CoderPersonContributes to this In the atlas: contributes to 9@Artemis-Coder17avasilev-sapPersonContributes to this In the atlas: contributes to 9@avasilev-sapbroksyPersonContributes to this In the atlas: contributes to 11@broksyChristoph GollmickPersonContributes to this In the atlas: contributes to 11, wrote 1@cfg74Cian MorrinPersonContributes to this In the atlas: contributes to 15@cianmSAPCiaraPersonContributes to this In the atlas: contributes to 8@ciaradaly2021colindoherty1PersonContributes to this In the atlas: contributes to 8@colindoherty185 contributors
What it declares
Every artifact
Type
Package
Origin
By SAP
As a package
Where it runs
does not say
declared, Where the library runs once installed: inside its host (loaded into the CAP application, installed into the ABAP system, loaded by the UI5 application), in a program of your own, or only at build time.
Distributed through
npm
declared, How it is installed, as its documentation tells a user to get it., read npm install @sap-ux/fiori-docs-embeddings — @sap-ux/fiori-docs-embeddings — README, 2026-10-18
Connections1
Group by
NodeRelationConditionBasis
Functional1
DocumentationDocumentationcapabilityFinding answers in written documentation, and writing what is missingSAP and community, unassessed
→provides
Indexes SAP Fiori documentation from several GitHub sources and generates vector embeddings for semantic search.
provides Documentation
Functional, stated
For
Indexes SAP Fiori documentation from several GitHub sources and generates vector embeddings for semantic search.
Basis
“A Node.js package that indexes SAP Fiori related documentation from multiple sources and generates vector embeddings for semantic search capabilities.”@sap-ux/fiori-docs-embeddings — README, checked
stated
provides Documentation
Functional, stated
For
Indexes SAP Fiori documentation from several GitHub sources and generates vector embeddings for semantic search.
Basis
“A Node.js package that indexes SAP Fiori related documentation from multiple sources and generates vector embeddings for semantic search capabilities.”@sap-ux/fiori-docs-embeddings — README, checked
Finding answers in written documentation, and writing what is missing
Parses markdown, JSON, TypeScript, and other file types
Generates AI-powered vector embeddings using transformers
Stores embeddings in a flat binary vector store (embeddings.bin + records.jsonl)
Provides tools for semantic and keyword search across documentation
Installation
npm install @sap-ux/fiori-docs-embeddings
Usage
Basic Usage
import { getDataPath, getEmbeddingsPath } from '@sap-ux/fiori-docs-embeddings';// Get paths to data directoriesconst docsPath = getDataPath();const embeddingsPath = getEmbeddingsPath();
Building Documentation Index
# Set GitHub token to avoid rate limitsexport GITHUB_TOKEN=your_github_token# Build documentation index (all sources)npm run update-docs# Build a single source by IDnpm run update-docs-script -- --source=fiori-tools-opa-guide# Shortcut script for the OPA testing guidenpm run update-docs-opa-guide# Generate embeddingsnpm run update-embeddings# Or do bothnpm run update-all
Available Scripts
update-docs - Crawl and index documentation from all configured sources
update-docs-script -- --source=<id> - Crawl a single source by ID
update-docs-opa-guide - Fetch only the OPA mock server testing guide
update-embeddings - Generate vector embeddings from indexed documents
update-all - Run both documentation indexing and embedding generation
Configuration
The module indexes documentation from these sources by default:
Packages in the SAP Open UX Tools monorepo have been migrated from CommonJS (CJS) to ECMAScript Modules (ESM) with NodeNext module resolution.
'@sap-ux/backend-proxy-middleware-cf' is experimental and will remain at major version 0.
'@sap-ux/generator-odata-downloader' is a top level yeoman generator and will remain as CJS until validation as ESM is done.
What Changed
Module System: Most packages now use native ESM ("type": "module" in package.json)
TypeScript Configuration: Updated to module: "NodeNext" and moduleResolution: "NodeNext"
Import Statements: All relative imports now include explicit .js extensions (per ESM spec)
Build Output: Generated JavaScript files are now ESM modules
Node.js Requirement: Minimum Node.js version remains >=22.x
Jest Configuration (for Testing)
If your project tests code that imports these packages, update your Jest configuration:
DocumentationDocumentationcapabilityFinding the answer in what has already been written, and writing it where it has not — first-party documentation made searchable by something other than a person scrolling it, including by an agent, and a document of custom code produced from the code itself.SAP and community, unassessed
abap2UI5 Playgroundabap2UI5 Playgroundweb-toolABAP in the editor on the left and the abap2UI5 app it builds on the right, both inside one browser tab: the framework is transpiled to JavaScript at build time and the class in the editor is compiled when Run is pressed.community org, abapIn-browser ABAP editor beside the abap2UI5 app it buildsfrom ABAP
@cap-js/mcp-server@cap-js/mcp-servermcp-serverSAP's MCP server for CAP development, run as cds-mcp: search_model searches the project's compiled CDS model, search_docs searches the CAP documentation indexed as embeddings on the developer's own machine.sap official, capMCP server for CAP development: model and docs searchfrom CAP
mcp-sap-docsmcp-sap-docsmcp-serverAn MCP server over seventeen cloned SAP documentation repositories — ABAP keyword docs, capire, OpenUI5, Cloud SDK, BTP — searched with BM25 and prebuilt embeddings fused by reciprocal rank fusion.independent, capMCP server searching seventeen SAP documentation repositoriesfrom CAP
sap-api-hub-mcpsap-api-hub-mcpmcp-serverA read-only MCP server over the SAP Business Accelerator Hub catalogue: categories, search, metadata, resources, specs and packages, reached as the caller's own SAP user.independent, btpRead-only MCP server over the SAP Business Accelerator Hubfrom BTP/BAIP
sap-note-search-mcpsap-note-search-mcpmcp-serverAn MCP server over SAP Notes and Knowledge Base articles: search finds a note, fetch returns it whole, and a scripted browser does the S-user login the content sits behind.independent, btpMCP server searching and fetching SAP Notes and KBAsfrom BTP/BAIP
sap-roadmap-mcpsap-roadmap-mcpmcp-serverAn MCP server over SAP Road Map Explorer, so an agent can read what SAP has announced as planned rather than inferring it from a release that has shipped.independent, btpMCP server over SAP Road Map Explorerfrom BTP/BAIP
ui5-lib-diffui5-lib-diffweb-toolA hosted app that lists what changed between two SAPUI5 or OpenUI5 versions from the UI5 API's change records, and publishes the same data as static JSON files at fixed paths for tools and agents.independent, ui5Hosted app listing changes between SAPUI5 or OpenUI5 versionsfrom UI5
abap-docabap-doccliA Node.js command that reads an ABAP package and its sub-packages over ADT and writes one PDF documenting every object in it, with an LLM writing the prose.independent, abapNode.js command writing PDF documentation for an ABAP packagefrom ABAP
sap-ai-docs-mcpsap-ai-docs-mcpmcp-serverAn MCP server with semantic search, category filtering and whole-page retrieval over SAP AI Core's documentation, from the SAP-docs/sap-artificial-intelligence repository.independent, btpMCP server with semantic search over SAP AI Core documentationfrom BTP/BAIP
sap-btp-docs-mcpsap-btp-docs-mcpmcp-serverAn MCP server for semantic search over the SAP BTP documentation repository, filtered by area such as development, administration, integration or security, with full document retrieval.independent, btpMCP server with semantic search over SAP BTP documentationfrom BTP/BAIP
Clean-Core.ioClean-Core.ioweb-toolA free hosted workspace that reads one piece of custom ABAP, redraws its business process as BPMN with a line anchor on every element, grades the SAP objects it uses Level A–D and ends in a keep, rebuild, move-to-standard or retire decision.independent, abapHosted workspace redrawing custom ABAP as BPMN and grading itfrom ABAP
abapdocs-code-scannerabapdocs-code-scannerpackageReads the abapDoc comments of a class or interface's public methods and type definitions and returns their text at runtime.independent, abapReads the abapDoc comments of a class or interface's public methods and type definitions and returns their text at runtime.from ABAP
@ui5/webcomponents-mcp-server@ui5/webcomponents-mcp-servermcp-serverFour tools that answer an agent's questions about UI5 Web Components from the framework's own documentation — component API, integration guides, and the docs themselves.sap official, ui5MCP server answering questions on UI5 Web Componentsfrom UI5
vscode-ui5-api-referencevscode-ui5-api-referenceide-extensionVS Code extension that shows the SAPUI5 and OpenUI5 API reference in a side bar view, with inherited members, member filters and a favourites list, for one framework version at a time.independent, ui5VS Code side bar view of the SAPUI5 and OpenUI5 API referencefrom UI5
