@sap-ux/fiori-mcp-server 0.0.5 → 0.0.6

package/dist/server.d.ts

@@ -14,6 +14,10 @@ export declare class FioriFunctionalityServer {
      * Logs MCP errors and handles the SIGINT signal for graceful shutdown.
      */
     private setupErrorHandling;
+    /**
+     * Sets up telemetry.
+     */
+    private setupTelemetry;
     /**
      * Sets up handlers for various MCP tools.
      * Configures handlers for listing tools, and calling specific Fiori functionality tools.

package/dist/server.js

@@ -10,6 +10,7 @@ const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
 const types_js_1 = require("@modelcontextprotocol/sdk/types.js");
 const package_json_1 = __importDefault(require("../package.json"));
 const tools_1 = require("./tools");
+const telemetry_1 = require("./telemetry");
 /**
  * Sets up and manages an MCP (Model Context Protocol) server that provides Fiori-related tools.
  */
@@ -42,6 +43,12 @@ class FioriFunctionalityServer {
             process.exit(0);
         });
     }
+    /**
+     * Sets up telemetry.
+     */
+    async setupTelemetry() {
+        await telemetry_1.TelemetryHelper.initTelemetrySettings();
+    }
     /**
      * Sets up handlers for various MCP tools.
      * Configures handlers for listing tools, and calling specific Fiori functionality tools.
@@ -56,22 +63,30 @@ class FioriFunctionalityServer {
             const { name, arguments: args } = request.params;
             try {
                 let result;
+                telemetry_1.TelemetryHelper.markToolStartTime();
+                const telemetryProperties = {
+                    tool: name,
+                    functionalityId: args?.functionalityId
+                };
                 switch (name) {
                     case 'list-fiori-apps':
                         result = await (0, tools_1.listFioriApps)(args);
-                        return this.convertResultToCallToolResult(result);
+                        break;
                     case 'list-functionality':
                         result = await (0, tools_1.listFunctionalities)(args);
-                        return this.convertResultToCallToolResult(result);
+                        break;
                     case 'get-functionality-details':
                         result = await (0, tools_1.getFunctionalityDetails)(args);
-                        return this.convertResultToCallToolResult(result);
+                        break;
                     case 'execute-functionality':
                         result = await (0, tools_1.executeFunctionality)(args);
-                        return this.convertResultToCallToolResult(result);
+                        break;
                     default:
+                        await telemetry_1.TelemetryHelper.sendTelemetry(telemetry_1.unknownTool, telemetryProperties, args?.appPath);
                         throw new Error(`Unknown tool: ${name}. Try one of: list-fiori-apps, list-functionality, get-functionality-details, execute-functionality.`);
                 }
+                await telemetry_1.TelemetryHelper.sendTelemetry(name, telemetryProperties, args?.appPath);
+                return this.convertResultToCallToolResult(result);
             }
             catch (error) {
                 const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred';
@@ -113,6 +128,7 @@ class FioriFunctionalityServer {
     async run() {
         const transport = new stdio_js_1.StdioServerTransport();
         await this.server.connect(transport);
+        await this.setupTelemetry();
         console.error('Fiori Functionality MCP Server running on stdio');
     }
 }

package/dist/telemetry/index.d.ts

@@ -0,0 +1,68 @@
+import { type TelemetryProperties, type ToolsSuiteTelemetryInitSettings } from '@sap-ux/telemetry';
+export declare const mcpServerName = "@sap-ux/fiori-mcp-server";
+export declare const unknownTool = "unknown-tool";
+export interface TelemetryData {
+    [key: string]: string;
+}
+/**
+ * Helper class for intialising and preparing event data for telemetry.
+ */
+export declare abstract class TelemetryHelper {
+    private static _telemetryData;
+    private static _previousEventTimestamp;
+    /**
+     * Returns the telemetry data.
+     *
+     * @returns telemetry data
+     */
+    static get telemetryData(): TelemetryData;
+    /**
+     * Load telemetry settings.
+     *
+     * @param options - tools suite telemetry init settings
+     */
+    static initTelemetrySettings(options?: ToolsSuiteTelemetryInitSettings): Promise<void>;
+    /**
+     * Creates telemetry data and adds default telemetry props.
+     *
+     * @param additionalData - set additional properties to be reported by telemetry
+     * @param filterDups - filters duplicates by returning undefined if it's suspected to be a repeated event based on previous telemetry data & timestamp (1 second)
+     * @returns telemetry data
+     */
+    static createTelemetryData<T extends TelemetryProperties>(additionalData?: Partial<T>, filterDups?: boolean): TelemetryData | undefined;
+    /**
+     * Prepares the telemetry event by calculating the generation time if a mark name is provided.
+     *
+     * @param telemetryEventName - The name of the telemetry event
+     * @param telemetryData - The telemetry data
+     * @returns The prepared telemetry event
+     */
+    private static prepareTelemetryEvent;
+    /**
+     * Marks the start time. Example usage:
+     * At the start of the MCP tool calling phase.
+     * It should not be updated everytime calling createTelemetryData().
+     */
+    static markToolStartTime(): void;
+    /**
+     * Marks the end time. Example usage:
+     * At the end of the writing phase of the MCP tool calling phase.
+     */
+    static markToolsEndTime(): void;
+    /**
+     * Sends the telemetry event to the telemetry client.
+     *
+     * @param telemetryEventName - the event name to be reported
+     * @param telemetryData - the telemetry data
+     * @param appPath - the path of the application
+     * @returns - a promise that resolves when the event is sent
+     */
+    static sendTelemetry(telemetryEventName: string, telemetryData: TelemetryData, appPath?: string): Promise<void>;
+    /**
+     * Gets the telemetry name of the module.
+     *
+     * @returns The module telemetry name.
+     */
+    static getTelemetryName(): string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/telemetry/index.js

@@ -0,0 +1,146 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TelemetryHelper = exports.unknownTool = exports.mcpServerName = void 0;
+const telemetry_1 = require("@sap-ux/telemetry");
+const feature_toggle_1 = require("@sap-ux/feature-toggle");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const os_name_1 = __importDefault(require("os-name"));
+const i18next_1 = __importDefault(require("i18next"));
+const package_json_1 = require("../../package.json");
+exports.mcpServerName = '@sap-ux/fiori-mcp-server';
+exports.unknownTool = 'unknown-tool';
+const resourceId = '0a65e45d-6bf4-421d-b845-61e888c50e9e';
+/**
+ * Helper class for intialising and preparing event data for telemetry.
+ */
+class TelemetryHelper {
+    static _telemetryData;
+    static _previousEventTimestamp;
+    /**
+     * Returns the telemetry data.
+     *
+     * @returns telemetry data
+     */
+    static get telemetryData() {
+        return this._telemetryData;
+    }
+    /**
+     * Load telemetry settings.
+     *
+     * @param options - tools suite telemetry init settings
+     */
+    static async initTelemetrySettings(options) {
+        const telemetryOptions = {
+            consumerModule: {
+                name: exports.mcpServerName,
+                version: package_json_1.version
+            },
+            watchTelemetrySettingStore: false,
+            internalFeature: (0, feature_toggle_1.isInternalFeaturesSettingEnabled)(),
+            resourceId,
+            ...options
+        };
+        await (0, telemetry_1.initTelemetrySettings)(telemetryOptions);
+    }
+    /**
+     * Creates telemetry data and adds default telemetry props.
+     *
+     * @param additionalData - set additional properties to be reported by telemetry
+     * @param filterDups - filters duplicates by returning undefined if it's suspected to be a repeated event based on previous telemetry data & timestamp (1 second)
+     * @returns telemetry data
+     */
+    static createTelemetryData(additionalData, filterDups = false) {
+        const currentTimestamp = new Date().getTime();
+        if (!this._previousEventTimestamp) {
+            filterDups = false; // can't filter duplicates if no previous event timestamp
+            this._previousEventTimestamp = currentTimestamp;
+        }
+        if (!this._telemetryData) {
+            let osVersionName = i18next_1.default.t('telemetry.unknownOs');
+            try {
+                osVersionName = (0, os_name_1.default)();
+            }
+            catch {
+                // no matched os name, possible beta or unreleased version
+            }
+            this._telemetryData = {
+                Platform: (0, btp_utils_1.isAppStudio)() ? 'SBAS' : 'VSCode',
+                OperatingSystem: osVersionName
+            };
+        }
+        if (filterDups) {
+            const newTelemData = { ...this._telemetryData, ...additionalData };
+            if (Math.abs(this._previousEventTimestamp - currentTimestamp) < 1000 &&
+                JSON.stringify(newTelemData) === JSON.stringify(this._telemetryData)) {
+                return undefined;
+            }
+        }
+        this._previousEventTimestamp = currentTimestamp;
+        this._telemetryData = Object.assign(this._telemetryData, additionalData);
+        return this._telemetryData;
+    }
+    /**
+     * Prepares the telemetry event by calculating the generation time if a mark name is provided.
+     *
+     * @param telemetryEventName - The name of the telemetry event
+     * @param telemetryData - The telemetry data
+     * @returns The prepared telemetry event
+     */
+    static prepareTelemetryEvent(telemetryEventName, telemetryData) {
+        // Make sure performance measurement end is called
+        this.markToolsEndTime();
+        const requestTime = telemetryData.markName
+            ? telemetry_1.PerformanceMeasurementAPI.getMeasurementDuration(telemetryData.markName)
+            : undefined;
+        return {
+            eventName: telemetryEventName,
+            properties: telemetryData,
+            measurements: requestTime ? { RequestTime: requestTime } : {}
+        };
+    }
+    /**
+     * Marks the start time. Example usage:
+     * At the start of the MCP tool calling phase.
+     * It should not be updated everytime calling createTelemetryData().
+     */
+    static markToolStartTime() {
+        this.createTelemetryData({
+            markName: telemetry_1.PerformanceMeasurementAPI.startMark('MCP_LOADING_TIME')
+        });
+    }
+    /**
+     * Marks the end time. Example usage:
+     * At the end of the writing phase of the MCP tool calling phase.
+     */
+    static markToolsEndTime() {
+        if (this._telemetryData?.markName) {
+            telemetry_1.PerformanceMeasurementAPI.endMark(this._telemetryData.markName);
+            telemetry_1.PerformanceMeasurementAPI.measure(this._telemetryData.markName);
+        }
+    }
+    /**
+     * Sends the telemetry event to the telemetry client.
+     *
+     * @param telemetryEventName - the event name to be reported
+     * @param telemetryData - the telemetry data
+     * @param appPath - the path of the application
+     * @returns - a promise that resolves when the event is sent
+     */
+    static async sendTelemetry(telemetryEventName, telemetryData, appPath) {
+        const telemetryEvent = this.prepareTelemetryEvent(telemetryEventName, telemetryData);
+        await telemetry_1.ClientFactory.getTelemetryClient().reportEvent(telemetryEvent, telemetry_1.SampleRate.NoSampling, appPath ? { appPath } : undefined);
+    }
+    /**
+     * Gets the telemetry name of the module.
+     *
+     * @returns The module telemetry name.
+     */
+    static getTelemetryName() {
+        return exports.mcpServerName;
+    }
+}
+exports.TelemetryHelper = TelemetryHelper;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-mcp-server",
   "description": "SAP Fiori - Model Context Protocol (MCP) server",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "keywords": [
     "SAP Fiori tools",
     "SAP Fiori elements",
@@ -31,19 +31,23 @@
     "@types/json-schema": "7.0.5",
     "@types/mem-fs": "1.1.2",
     "@sap-ux/i18n": "0.3.3",
-    "@sap-ux/text-document-utils": "0.3.1",
     "@sap-ux/odata-annotation-core-types": "0.4.5",
-    "@sap-ux/odata-entity-model": "0.3.1"
+    "@sap-ux/odata-entity-model": "0.3.1",
+    "@sap-ux/text-document-utils": "0.3.1"
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "1.17.4",
-    "@sap/ux-specification": "1.136.4",
     "@sap-ux/annotation-converter": "0.10.3",
+    "@sap/ux-specification": "1.136.4",
     "i18next": "25.3.0",
+    "os-name": "4.0.1",
     "zod": "4.1.5",
+    "@sap-ux/btp-utils": "1.1.1",
     "@sap-ux/fiori-annotation-api": "0.6.17",
     "@sap-ux/nodejs-utils": "0.2.3",
-    "@sap-ux/project-access": "1.30.13"
+    "@sap-ux/project-access": "1.30.13",
+    "@sap-ux/feature-toggle": "0.3.1",
+    "@sap-ux/telemetry": "0.6.19"
   },
   "engines": {
     "node": ">=20.x"