onedevatlasBeta
Browse the atlas
AllCAPUI5ABAPBTP
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.

GitHub160 ★
npm45,009/wk

Facts

Latestv1.2.8ReleasedLast pushLicenceApache-2.0

Where it sits

Lives in
CAP
Provides
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
Distributed through
npm

Connections1

Install

npm add @sap-ux/fiori-docs-embeddings

Derived from the package name. No recipe recorded; the README has the configuration.

README

quoted from SAP/open-ux-tools under Apache-2.0, read
SAP/open-ux-tools/packages/fiori-docs-embeddings/README.mdOn GitHub

Changelog Github repo

@sap-ux/fiori-docs-embeddings

A Node.js package that indexes SAP Fiori related documentation from multiple sources and generates vector embeddings for semantic search capabilities.

What it does

This module- Crawls documentation from GitHub repositories (see Configuration for a list of default sources) Example sources:

https://github.com/SAP-docs/btp-fiori-tools (Fiori Tools documentation)

https://github.com/SAP-docs/sapui5/tree/main/docs/06_SAP_Fiori_Elements (UI5 Fiori Elements documentation)

https://github.com/SAP-samples/fiori-tools-samples (Sample applications)

https://github.com/SAP-samples/fiori-elements-feature-showcase (Feature examples)

https://ui5.sap.com/test-resources/sap/fe/macros/designtime/apiref/api.json (Design Time API Reference)

https://ui5.sap.com/test-resources/sap/fe/core/fpmExplorer/index.html#/overview/introduction (SAP Fiori Development Portal)

https://github.com/SAP/open-ux-tools/blob/main/packages/create/README.md (Fiori Tools create documentation)

https://www.npmjs.com/package/@sap/ux-ui5-tooling (@sap/ux-ui5-tooling documentation)

https://github.com/sap-tutorials/Tutorials/blob/master/tutorials/fiori-tools-mockserver-opa-testing/fiori-tools-mockserver-opa-testing.md (OPA mock server testing guide)

  • 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 directories
const docsPath = getDataPath();
const embeddingsPath = getEmbeddingsPath();
Building Documentation Index
# Set GitHub token to avoid rate limits
export GITHUB_TOKEN=your_github_token

# Build documentation index (all sources)
npm run update-docs

# Build a single source by ID
npm run update-docs-script -- --source=fiori-tools-opa-guide

# Shortcut script for the OPA testing guide
npm run update-docs-opa-guide

# Generate embeddings
npm run update-embeddings

# Or do both
npm 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:

Source IDDescription
btp-fiori-toolsSAP-docs/btp-fiori-tools — Fiori Tools documentation
sapui5SAP-docs/sapui5 — UI5 Fiori Elements documentation
fiori-samplesSAP-samples/fiori-tools-samples — Sample applications
fiori-showcaseSAP-samples/fiori-elements-feature-showcase — Feature examples
tools-suiteux-engineering/tools-suite — Internal Fiori Tools commands (requires GITHUB_TOKEN)
fiori-tools-opa-guidesap-tutorials/Tutorials — OPA mock server testing guide
Environment Variables
  • GITHUB_TOKEN - GitHub personal access token (recommended to avoid rate limits)
Data Structure

Generated data is organized as:

data/
├── docs/           # Parsed documentation files
├── embeddings/     # Flat binary vector store (embeddings.bin, records.jsonl, metadata.json)
└── search/         # Search indexes

Features

  • Multi-source indexing - Supports GitHub repositories and JSON APIs
  • File type support - Markdown, JSON, TypeScript, JavaScript, XML, YAML, and more
  • Vector embeddings - Uses @huggingface/transformers with the Xenova/all-MiniLM-L6-v2 model (q8 quantized)
  • Local storage - All data stored locally as a flat binary vector store (no native database dependency)
  • Caching - Intelligent caching to avoid unnecessary API calls
  • Chunking - Smart document chunking for optimal embedding generation

Development

# Install dependencies
npm install

# Run tests
npm test

# Check types
npm run build-compiler

# Clean generated files
npm run clean

License

Apache-2.0

Apache-2.0, read

History

Latest

v1.2.8

Fixes 1

Notes
Patch Changes
Release Date

2026-10-05

Bug Fixes
  • Replace opa5_docu.md and fiori-tools-opa-guide.md with OPA5 skill reference files as embeddings source [3c76112]

  1. v1.2.7

    Fixes, Dependencies 1

    Notes
    Patch Changes
    Release Date

    2026-08-10

    Dependency Updates
    • Rebuild embeddings with updated @sap-ux/create docs (update metadata command, --service and --no-value-help options, EDMX-backend-only limitation) [a5c33b0]

  2. v1.2.6

    Features 1, Fixes

    Notes
    Patch Changes
    Release Date

    2026-07-08

    Features
    • Add sap.fe.test JSDoc API as a new embedded data source [d54fc9a]

  3. v1.2.5

    Dependencies 1

    Notes
    Patch Changes
    Dependency Updates
    • Bulk upgrade of minor dependencies and devDependencies [5ce779c]

  4. v1.2.4

    Fixes 1

    Notes
    Patch Changes
    Release Date

    2026-06-30

    Bug Fixes
    • Trigger @sap-ux/fiori-mcp-server release [17354e0]

  5. v1.2.3

    Fixes 1

    Notes
    Patch Changes
    Release Date

    2026-06-18

    Bug Fixes
    • Validate GitHub host/token inputs to prevent argument injection; validate output path to prevent path traversal [74a9959]

  6. v1.2.2

    Fixes 1

    Notes
    Patch Changes
    Release Date

    2026-06-18

    Bug Fixes
    • Update opa5_docu.md: clear filter fields [6776415]

  7. v1.2.1

    Fixes 1

    Notes
    Patch Changes
    Release Date

    2026-06-16

    Bug Fixes
    • OPA5 embeddings chunk formatting [70f934e]

  8. v1.2.0

    Features 1

    Notes

    Released: 2026-06-12T08:20:17Z

    Minor Changes
    • 08fb7a1: Add opa5_docu.md

  9. v1.1.1

    Fixes 1

    Notes

    Released: 2026-06-11T15:27:53Z

    Patch Changes
    • 4124656: Add OPA mock server testing guide as github-raw doc source and --source CLI flag for single-source builds

  10. v1.1.0

    Features 1

    Notes

    Released: 2026-06-05T11:08:04Z

    Minor Changes
    • 9f33150: Replace @xenova/transformers with @huggingface/transformers 4.2.0.

  11. v1.0.1

    Fixes 1

    Notes

    Released: 2026-06-03T14:58:37Z

    Patch Changes
    • 21a3de7: FIX: TypeScript type errors in test files (ESM migration follow-up)

  12. v1.0.0dated in the atlas

    Breaking 1

    Notes

    Released: 2026-05-30T20:54:07Z

    Major Changes

    • 32609a7: # Migration to ECMAScript Modules (ESM)

      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:

      export default {
    extensionsToTreatAsEsm: ['.ts'],
    transform: {
        '^.+\\.ts$': ['ts-jest', { useESM: true }]
    }
};

      And run Jest with: NODE_OPTIONS='--experimental-vm-modules' jest

  13. v0.5.1

    Fixes 1

    Notes

    Released: 2026-05-21T05:46:16Z

    Patch Changes
    • 12137f6: update doc for fiori extension

  14. v0.5.0

    Features 1

    Notes

    Released: 2026-05-15T08:12:20Z

    Minor Changes
    • 72695e5: chore: drop Node 20 support as it is no longer maintained

  15. v0.4.20

    Fixes 1

    Notes

    Released: 2026-05-14T12:51:22Z

    Patch Changes
    • 59537d3: chore: override sharp to >=0.33.5 to fix CI build on darwin-arm64

  16. v0.4.19

    Fixes 1

    Notes

    Released: 2026-05-14T11:45:51Z

    Patch Changes
    • 50a8ba5: chore: fresh release after workflow updates

  17. v0.4.18

    Fixes 1

    Notes

    Released: 2026-05-11T09:58:34Z

    Patch Changes
    • a5c05a8: Add additional guidance on the adding of extension in fiori

  18. v0.4.17

    Fixes 1

    Notes

    Released: 2026-05-04T15:49:13Z

    Patch Changes
    • e4a2488: feat - docs - how to add extensions to odata v4 fiori elements

  19. v0.4.16

    Fixes 1

    Notes

    Released: 2026-02-27T15:42:39Z

    Patch Changes

    • ca2566b: Update fast-xml-parser

      Issue: #37278

  20. v0.4.15

    Fixes 1

    Notes

    Released: 2026-02-18T21:45:35Z

    Patch Changes
    • d57cc47: Update fast-xml-parser

  21. v0.4.14

    Fixes 1

    Notes

    Released: 2026-02-10T21:03:43Z

    Patch Changes
    • 3795bb2: Add Node.js engine requirement (>=20.x)

  22. v0.4.13

    Fixes 1

    Notes

    Released: 2026-02-03T15:42:23Z

    Patch Changes
    • c3a1e07: fix: add documentation sources

  23. v0.4.12

    Fixes 1

    Notes

    Released: 2026-01-30T16:18:20Z

    Patch Changes
    • 4eac0a7: Improve chunk creation to ensure code samples are not modified.

  24. v0.4.11

    Fixes 1

    Notes

    Released: 2026-01-28T10:59:00Z

    Patch Changes
    • a686522: feat: add Fiori Tools commands and update total document count

  25. v0.4.10

    Fixes 1

    Notes

    Released: 2026-01-23T17:12:38Z

    Patch Changes
    • c99758e: chore - Update embeddings docs from original sources for mcp server

  26. v0.4.9

    Fixes 1

    Notes

    Released: 2026-01-12T09:10:27Z

    Patch Changes
    • d667a5e: fix: add repository field to package.json

  27. v0.4.8

    Fixes 1

    Notes

    Released: 2026-01-09T11:35:48Z

    Patch Changes
    • e111d0d: fix sonar issues

  28. v0.4.7

    Fixes 1

    Notes

    Released: 2025-12-18T21:05:02Z

    Patch Changes
    • a9471d0: fix sonar issues

  29. v0.4.6

    Fixes 1

    Notes

    Released: 2025-12-15T10:50:50Z

    Patch Changes
    • 4ecfbe2: Chore - upgrade eslint devDependenies, convert to flat config and fix lint issues.

  30. v0.4.5

    Fixes 1

    Notes

    Released: 2025-12-01T17:31:14Z

    Patch Changes
    • 7cb3db2: feat: enhance downloaded readme content for better chunking

  31. v0.4.4

    Fixes 1

    Notes

    Released: 2025-11-13T12:25:56Z

    Patch Changes
    • 10eb73e: fix: use existing version of ux-ui5-tooling-README.md in case of download errors

  32. v0.4.3

    Fixes 1

    Notes

    Released: 2025-11-11T19:29:27Z

    Patch Changes
    • a990ed6: feat: add @sap-ux/create/README.md as resource

  33. v0.4.2

    Fixes 1

    Notes

    Released: 2025-11-05T06:53:42Z

    Patch Changes
    • cfe9c13: Add deep link to package and changelog to README.md

  34. v0.4.1

    Fixes 1

    Notes

    Released: 2025-10-22T18:56:41Z

    Patch Changes
    • fa9580c: chore - Rimraf upgrade

  35. v0.4.0

    Features 1

    Notes

    Released: 2025-10-20T15:41:39Z

    Minor Changes
    • 27585ad: Pre-process document sources with LLM and to clean-up an optimize for RAG code generation.

  36. v0.3.0

    Features 1

    Notes

    Released: 2025-10-15T11:11:41Z

    Minor Changes
    • e75b594: Add Fiori Development portal documentation to embeddings

  37. v0.2.0

    Features 1

    Notes

    Released: 2025-10-09T12:00:16Z

    Minor Changes
    • b5b6c9c: Add FPM Development portal documentation to embeddings

  38. v0.1.1

    Fixes 1

    Notes

    Released: 2025-10-06T17:09:01Z

    Patch Changes
    • 43a2446: chore: fix Sonar issues

  39. v0.1.0

    Features 1

    Notes

    Released: 2025-10-06T11:26:22Z

    Minor Changes
    • b179405: Refactor doc search to return human readable results. Simplify search and doc indexing

  40. v0.0.2

    Fixes 1

    Notes

    Released: 2025-09-18T23:50:28Z

    Patch Changes
    • 306561e: Fix publishing of embeddings package

  41. v0.0.1

    Fixes 1

    Notes

    Released: 2025-09-17T14:22:31Z

    Patch Changes
    • a7b6272: Add doc_search tool to Fiori MCP server using data from embeddings module.
On GitHub
17,460downloads per week, npm
Weekly downloads for @sap-ux/fiori-docs-embeddings26 complete calendar weeks from 2026-04-27 to 2026-10-25; the latest total is 17460.27 Apr – 3 May: 19,7484 May – 10 May: 22,82811 May – 17 May: 25,09518 May – 24 May: 25,33725 May – 31 May: 52,4071 Jun – 7 Jun: 101,6798 Jun – 14 Jun: 111,86215 Jun – 21 Jun: 115,00822 Jun – 28 Jun: 104,03329 Jun – 5 Jul: 107,2636 Jul – 12 Jul: 105,47113 Jul – 19 Jul: 114,13720 Jul – 26 Jul: 109,38227 Jul – 2 Aug: 101,5113 Aug – 9 Aug: 105,58910 Aug – 16 Aug: 78,74917 Aug – 23 Aug: 95,96224 Aug – 30 Aug: 106,16131 Aug – 6 Sept: 78,9117 Sept – 13 Sept: 61,74314 Sept – 20 Sept: 71,67421 Sept – 27 Sept: 90,89128 Sept – 4 Oct: 99,0905 Oct – 11 Oct: 90,48512 Oct – 18 Oct: 44,49419 Oct – 25 Oct: 17,460

Others providing3

Compare all 4 on the Documentation page →
Documentation
  1. @cap-js/mcp-serverMCP server for CAP development: model and docs search
  2. mcp-sap-docsMCP server searching seventeen SAP documentation repositories
  3. Clean-Core.ioHosted workspace redrawing custom ABAP as BPMN and grading it

Details

Sources5
npm registrydiscovered herechecked
The discovery passdiscovered herechecked
npm registry, @sap-ux/fiori-docs-embeddingsversion, releases, installschecked
github.com/https://github.com/SAP/open-ux-tools.gittree, pushes, contributors, CIchecked
packages/fiori-docs-embeddings/README.mdquoted, and what the entry declareschecked

Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.

Compatibility and provenance
latestv1.2.8
first release
releases and cadence39, ~5d median
discovered vianpm registry, The discovery pass
first seen in the atlas
ecosystem and domaincap, learning-and-reference
Contributors85
Andis RedmansAisling NooneAlina GovoruhinaArtemis Coderavasilev-sapbroksyChristoph GollmickCian MorrinCiaracolindoherty1Dr. Markus KönigsteinDaniel ShterevDanyal AslamAustin DevineDavid O'ConnorDonal Tobin (SAP)Dirk TeufelJan DudaEmre CevikEdouard Ouinfionan-SAPfred-ops-at-workGDamyanovgernotkuhr
Show 61 more
Goran PeucDominik HeimHitesh ParmarIainSAPIvoSGJimmy JosephJohannes KolbeKamalKumarSardiwalkitzkanKlaus Kellerkorotkovaokranthie-sapLukas BöhmLouise FindlayLiamM2004J LongManuelPastoriniMarco ViethMarius FreitagMartin JanuskaMaruf RasullyMatthias OßwaldVilim Mikicmmilko01mushegh-sapMustafa Mengütaynafis0077Nafees AhmedNikita B.Nicolas LunetOlivers BerzsPeter MuessigPetrStribrnyRomans Koldunssanat-thukralOndřej ŠebelaStefan SchreckSharmavkshSaurabh KumarShen LinSRKPendyalatestojsSushant PriyadarshiThomas-NeuhauserTobias QueckTomUBSusmithaFreddy Jetty JohnsonUllas HollaChristos KoutsiarisTommyUwe Schwerkvadson71Vincent EscaliervinayhospeteVladislavs-Silins-SAPVolker BuzekDavis VoicescuksIlya KlopkovAnnemarie FrankZdravko Georgiev

From the repository’s contributor list, .

History in the atlas3
  1. Typed cds-plugin by placement, which defaults every candidate to that. It is not one.
  2. Fiori documentation indexed as embeddings, which is what makes it searchable by something other than a person scrolling it.
  3. First seen.
For your agent
Ref
artifact:sap-ux-fiori-docs-embeddings
JSON
/artifacts/sap-ux-fiori-docs-embeddings.json
MCP
Connecting an agent