From e4ca07619009a2c80a43e9bcd1a4c488c153712f Mon Sep 17 00:00:00 2001 From: Johannes Kolbe Date: Tue, 14 Oct 2025 14:23:54 +0200 Subject: [PATCH 1/5] chore: readme - telemetry --- packages/fiori-mcp-server/README.md | 33 +++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/packages/fiori-mcp-server/README.md b/packages/fiori-mcp-server/README.md index 102af8720cc..a88dda6cfc5 100644 --- a/packages/fiori-mcp-server/README.md +++ b/packages/fiori-mcp-server/README.md @@ -100,6 +100,39 @@ Gets the required parameters and detailed information for a specific functionali #### `execute_functionality` (Step 3 of 3) Executes a specific functionality to create a new or modify an existing SAP Fiori application with provided parameters. + +## [Telemetry](#telemetry) + +You can enable and disable the collection of analytics. If enabled, non-personally identifiable information is used to help understand how you use the product to improve the Fiori MCP Server. + +There are two ways to enable or disable telemetry: + +### Method 1: Configuration File + +Create or change the file `~/.fioritools/telemetrysettings.json`: + +```json +{ + "telemetrysettings": { + "telemetrySetting": { + "enableTelemetry": false + } + } +} +``` + +Set `enableTelemetry` to `false` to disable telemetry collection. + +### Method 2: Environment Variable + +Set the environment variable `SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY` to `false`: + +```bash +export SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY=false +``` + +Setting this environment variable will disable the telemetry client. + ## Code of Conduct Everyone participating in this joint project is welcome as long as our [Code of Conduct](https://github.com/SAP/open-ux-tools/blob/main/docs/CODE_OF_CONDUCT.md) is being adhered to. From 6a6d598d3ad8303a9f6bd9674a003dd95ce5cd4e Mon Sep 17 00:00:00 2001 From: Johannes Kolbe <106824015+johannes-kolbe@users.noreply.github.com> Date: Tue, 14 Oct 2025 15:07:24 +0200 Subject: [PATCH 2/5] fix: env variable instruction --- packages/fiori-mcp-server/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/fiori-mcp-server/README.md b/packages/fiori-mcp-server/README.md index a88dda6cfc5..f7e49dcf7be 100644 --- a/packages/fiori-mcp-server/README.md +++ b/packages/fiori-mcp-server/README.md @@ -125,7 +125,7 @@ Set `enableTelemetry` to `false` to disable telemetry collection. ### Method 2: Environment Variable -Set the environment variable `SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY` to `false`: +Set the environment variable `SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY` to `true`: ```bash export SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY=false From 33da12fbf4919a80a81bcedeb9ce415bec9a9e2a Mon Sep 17 00:00:00 2001 From: Johannes Kolbe <106824015+johannes-kolbe@users.noreply.github.com> Date: Tue, 14 Oct 2025 15:07:33 +0200 Subject: [PATCH 3/5] fix: env variable instruction --- packages/fiori-mcp-server/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/fiori-mcp-server/README.md b/packages/fiori-mcp-server/README.md index f7e49dcf7be..1665ad3f52b 100644 --- a/packages/fiori-mcp-server/README.md +++ b/packages/fiori-mcp-server/README.md @@ -128,7 +128,7 @@ Set `enableTelemetry` to `false` to disable telemetry collection. Set the environment variable `SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY` to `true`: ```bash -export SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY=false +export SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY=true ``` Setting this environment variable will disable the telemetry client. From e300d66505d3106f84e329ab7eda5ab8e0dca163 Mon Sep 17 00:00:00 2001 From: Johannes Kolbe <106824015+johannes-kolbe@users.noreply.github.com> Date: Tue, 14 Oct 2025 15:09:40 +0200 Subject: [PATCH 4/5] fix: telemetry description --- packages/fiori-mcp-server/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/packages/fiori-mcp-server/README.md b/packages/fiori-mcp-server/README.md index 1665ad3f52b..cc39f3c012b 100644 --- a/packages/fiori-mcp-server/README.md +++ b/packages/fiori-mcp-server/README.md @@ -103,9 +103,7 @@ Executes a specific functionality to create a new or modify an existing SAP Fior ## [Telemetry](#telemetry) -You can enable and disable the collection of analytics. If enabled, non-personally identifiable information is used to help understand how you use the product to improve the Fiori MCP Server. - -There are two ways to enable or disable telemetry: +You can enable and disable the collection of analytics. By default, non-personally identifiable information is used to help understand how you use the product to improve the Fiori MCP Server. In case you want to opt-out there exist two ways to disable the telemetry. ### Method 1: Configuration File From 05cdffef8371a1aec8ab39a134830afee749837b Mon Sep 17 00:00:00 2001 From: Johannes Kolbe Date: Mon, 20 Oct 2025 14:22:03 +0200 Subject: [PATCH 5/5] chore: changeset --- .changeset/sharp-garlics-rule.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/sharp-garlics-rule.md diff --git a/.changeset/sharp-garlics-rule.md b/.changeset/sharp-garlics-rule.md new file mode 100644 index 00000000000..7085e163804 --- /dev/null +++ b/.changeset/sharp-garlics-rule.md @@ -0,0 +1,5 @@ +--- +'@sap-ux/fiori-mcp-server': patch +--- + +chore: readme update - how to disable telemetry