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 diff --git a/packages/fiori-mcp-server/README.md b/packages/fiori-mcp-server/README.md index 2b863281c84..58ed2aba194 100644 --- a/packages/fiori-mcp-server/README.md +++ b/packages/fiori-mcp-server/README.md @@ -100,6 +100,37 @@ 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. 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 + +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 `true`: + +```bash +export SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY=true +``` + +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.