@contiva/sapbtp-docs-mcp 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/README.md +49 -53
  2. package/build/index.js +2 -2
  3. package/build/index.js.map +1 -1
  4. package/build/indexing/file-registry.d.ts.map +1 -1
  5. package/build/indexing/file-registry.js +2 -5
  6. package/build/indexing/file-registry.js.map +1 -1
  7. package/build/indexing/topic-index.d.ts.map +1 -1
  8. package/build/indexing/topic-index.js +8 -9
  9. package/build/indexing/topic-index.js.map +1 -1
  10. package/build/search/fulltext.d.ts.map +1 -1
  11. package/build/search/fulltext.js +3 -5
  12. package/build/search/fulltext.js.map +1 -1
  13. package/build/search/semantic.d.ts.map +1 -1
  14. package/build/search/semantic.js +4 -9
  15. package/build/search/semantic.js.map +1 -1
  16. package/build/search/title.d.ts.map +1 -1
  17. package/build/search/title.js +3 -5
  18. package/build/search/title.js.map +1 -1
  19. package/build/server.d.ts +17 -1
  20. package/build/server.d.ts.map +1 -1
  21. package/build/server.js +95 -5
  22. package/build/server.js.map +1 -1
  23. package/build/tools/get-related.d.ts.map +1 -1
  24. package/build/tools/get-related.js +4 -1
  25. package/build/tools/get-related.js.map +1 -1
  26. package/build/tools/list-topics.d.ts +2 -1
  27. package/build/tools/list-topics.d.ts.map +1 -1
  28. package/build/tools/list-topics.js +5 -4
  29. package/build/tools/list-topics.js.map +1 -1
  30. package/build/tools/read-article.d.ts +4 -0
  31. package/build/tools/read-article.d.ts.map +1 -1
  32. package/build/tools/read-article.js +24 -3
  33. package/build/tools/read-article.js.map +1 -1
  34. package/build/tools/search.d.ts +0 -6
  35. package/build/tools/search.d.ts.map +1 -1
  36. package/build/tools/search.js +9 -15
  37. package/build/tools/search.js.map +1 -1
  38. package/build/types/index.d.ts +2 -7
  39. package/build/types/index.d.ts.map +1 -1
  40. package/build/utils/docs-downloader.js +5 -5
  41. package/build/utils/docs-downloader.js.map +1 -1
  42. package/build/utils/paths.d.ts +9 -7
  43. package/build/utils/paths.d.ts.map +1 -1
  44. package/build/utils/paths.js +14 -29
  45. package/build/utils/paths.js.map +1 -1
  46. package/package.json +1 -1
@@ -27,11 +27,11 @@ export declare function resolveRelativeLink(sourcePath: string, linkHref: string
27
27
  export declare function isExternalLink(href: string): boolean;
28
28
  /**
29
29
  * Extracts the document area from a file path.
30
+ * For the unified BTP documentation, always returns 'btp'.
30
31
  *
31
- * @param filePath - Absolute or relative file path
32
- * @returns The document area (ISuite, ci, or apim)
32
+ * @returns The document area (always 'btp')
33
33
  */
34
- export declare function getDocumentArea(filePath: string): DocumentArea;
34
+ export declare function getDocumentArea(_filePath: string): DocumentArea;
35
35
  /**
36
36
  * Converts an absolute path to a path relative to the docs directory.
37
37
  */
@@ -54,14 +54,16 @@ export declare function getAreaPath(area: DocumentArea, docsPath: string): strin
54
54
  export declare function getIndexPath(area: DocumentArea, docsPath: string): string;
55
55
  /**
56
56
  * Checks if a file path belongs to a specific area.
57
+ * For unified BTP documentation, always returns true for 'btp' area.
57
58
  */
58
- export declare function isInArea(filePath: string, area: DocumentArea): boolean;
59
+ export declare function isInArea(_filePath: string, area: DocumentArea): boolean;
59
60
  /**
60
61
  * Gets all area paths that should be searched.
62
+ * For unified BTP documentation, returns the base docs path.
61
63
  *
62
- * @param area - The area filter ('all' or specific area)
64
+ * @param _area - The area filter (ignored for unified BTP docs)
63
65
  * @param docsPath - Base docs directory path
64
- * @returns Array of area paths to search
66
+ * @returns Array containing the docs path
65
67
  */
66
- export declare function getAreaPaths(area: DocumentArea | 'all', docsPath: string): string[];
68
+ export declare function getAreaPaths(_area: DocumentArea | 'all', docsPath: string): string[];
67
69
  //# sourceMappingURL=paths.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/utils/paths.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAMtD;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,MAAM,CASxC;AAED;;GAEG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAGxC;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAahF;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,CAa9D;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE9E;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAK9E;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAExE;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAGtE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,YAAY,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAUnF"}
1
+ {"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/utils/paths.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAMtD;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,MAAM,CASxC;AAED;;GAEG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAGxC;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAahF;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY,CAG/D;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE9E;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAK9E;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAExE;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAEvE;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,YAAY,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAGpF"}
@@ -56,23 +56,13 @@ export function isExternalLink(href) {
56
56
  }
57
57
  /**
58
58
  * Extracts the document area from a file path.
59
+ * For the unified BTP documentation, always returns 'btp'.
59
60
  *
60
- * @param filePath - Absolute or relative file path
61
- * @returns The document area (ISuite, ci, or apim)
61
+ * @returns The document area (always 'btp')
62
62
  */
63
- export function getDocumentArea(filePath) {
64
- const normalized = normalizePath(filePath);
65
- if (normalized.includes('/ISuite/') || normalized.includes('\\ISuite\\')) {
66
- return 'ISuite';
67
- }
68
- else if (normalized.includes('/ci/') || normalized.includes('\\ci\\')) {
69
- return 'ci';
70
- }
71
- else if (normalized.includes('/apim/') || normalized.includes('\\apim\\')) {
72
- return 'apim';
73
- }
74
- // Default to ISuite if can't determine
75
- return 'ISuite';
63
+ export function getDocumentArea(_filePath) {
64
+ // All documents belong to the unified BTP area
65
+ return 'btp';
76
66
  }
77
67
  /**
78
68
  * Converts an absolute path to a path relative to the docs directory.
@@ -107,26 +97,21 @@ export function getIndexPath(area, docsPath) {
107
97
  }
108
98
  /**
109
99
  * Checks if a file path belongs to a specific area.
100
+ * For unified BTP documentation, always returns true for 'btp' area.
110
101
  */
111
- export function isInArea(filePath, area) {
112
- const documentArea = getDocumentArea(filePath);
113
- return documentArea === area;
102
+ export function isInArea(_filePath, area) {
103
+ return area === 'btp';
114
104
  }
115
105
  /**
116
106
  * Gets all area paths that should be searched.
107
+ * For unified BTP documentation, returns the base docs path.
117
108
  *
118
- * @param area - The area filter ('all' or specific area)
109
+ * @param _area - The area filter (ignored for unified BTP docs)
119
110
  * @param docsPath - Base docs directory path
120
- * @returns Array of area paths to search
111
+ * @returns Array containing the docs path
121
112
  */
122
- export function getAreaPaths(area, docsPath) {
123
- if (area === 'all') {
124
- return [
125
- join(docsPath, 'ISuite'),
126
- join(docsPath, 'ci'),
127
- join(docsPath, 'apim'),
128
- ];
129
- }
130
- return [join(docsPath, area)];
113
+ export function getAreaPaths(_area, docsPath) {
114
+ // For unified BTP docs, always return the base docs path
115
+ return [docsPath];
131
116
  }
132
117
  //# sourceMappingURL=paths.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"paths.js","sourceRoot":"","sources":["../../src/utils/paths.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAG/E,0CAA0C;AAC1C,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAEtC;;;;GAIG;AACH,MAAM,UAAU,eAAe;IAC7B,6BAA6B;IAC7B,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC5C,CAAC;IAED,sEAAsE;IACtE,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,OAAO,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;AACnC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe;IAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,YAAY,CAAC;IAC3D,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAkB,EAAE,QAAgB;IACtE,2BAA2B;IAC3B,MAAM,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,6BAA6B;QAC7B,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAE9C,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,OAAO,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,QAAgB;IAC9C,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAE3C,IAAI,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QACzE,OAAO,QAAQ,CAAC;IAClB,CAAC;SAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxE,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5E,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,uCAAuC;IACvC,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,YAAoB,EAAE,QAAgB;IACpE,OAAO,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC1C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,YAAoB,EAAE,QAAgB;IACpE,IAAI,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC7B,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,OAAO,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,IAAkB,EAAE,QAAgB;IAC9D,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,IAAkB,EAAE,QAAgB;IAC/D,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;AAC1C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,QAAgB,EAAE,IAAkB;IAC3D,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IAC/C,OAAO,YAAY,KAAK,IAAI,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,IAA0B,EAAE,QAAgB;IACvE,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;QACnB,OAAO;YACL,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;YACxB,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC;YACpB,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;SACvB,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;AAChC,CAAC"}
1
+ {"version":3,"file":"paths.js","sourceRoot":"","sources":["../../src/utils/paths.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAG/E,0CAA0C;AAC1C,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAEtC;;;;GAIG;AACH,MAAM,UAAU,eAAe;IAC7B,6BAA6B;IAC7B,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC5C,CAAC;IAED,sEAAsE;IACtE,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,OAAO,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;AACnC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe;IAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,YAAY,CAAC;IAC3D,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAkB,EAAE,QAAgB;IACtE,2BAA2B;IAC3B,MAAM,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,6BAA6B;QAC7B,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAE9C,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,OAAO,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,SAAiB;IAC/C,+CAA+C;IAC/C,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,YAAoB,EAAE,QAAgB;IACpE,OAAO,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC1C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,YAAoB,EAAE,QAAgB;IACpE,IAAI,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC7B,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,OAAO,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,IAAkB,EAAE,QAAgB;IAC9D,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,IAAkB,EAAE,QAAgB;IAC/D,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;AAC1C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,SAAiB,EAAE,IAAkB;IAC5D,OAAO,IAAI,KAAK,KAAK,CAAC;AACxB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,KAA2B,EAAE,QAAgB;IACxE,yDAAyD;IACzD,OAAO,CAAC,QAAQ,CAAC,CAAC;AACpB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contiva/sapbtp-docs-mcp",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "description": "MCP server for SAP Business Technology Platform documentation - enables AI assistants to search and navigate SAP Business Technology Platform docs",
5
5
  "type": "module",
6
6
  "main": "./build/index.js",