@sap-ux/fiori-mcp-server 0.2.4 → 0.3.0

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 (3) hide show
  1. package/README.md +31 -0
  2. package/dist/index.js +431 -427
  3. package/package.json +11 -8
package/README.md CHANGED
@@ -100,6 +100,37 @@ Gets the required parameters and detailed information for a specific functionali
100
100
  #### `execute_functionality` (Step 3 of 3)
101
101
  Executes a specific functionality to create a new or modify an existing SAP Fiori application with provided parameters.
102
102
 
103
+
104
+ ## [Telemetry](#telemetry)
105
+
106
+ 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.
107
+
108
+ ### Method 1: Configuration File
109
+
110
+ Create or change the file `~/.fioritools/telemetrysettings.json`:
111
+
112
+ ```json
113
+ {
114
+ "telemetrysettings": {
115
+ "telemetrySetting": {
116
+ "enableTelemetry": false
117
+ }
118
+ }
119
+ }
120
+ ```
121
+
122
+ Set `enableTelemetry` to `false` to disable telemetry collection.
123
+
124
+ ### Method 2: Environment Variable
125
+
126
+ Set the environment variable `SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY` to `true`:
127
+
128
+ ```bash
129
+ export SAP_UX_FIORI_TOOLS_DISABLE_TELEMETRY=true
130
+ ```
131
+
132
+ Setting this environment variable will disable the telemetry client.
133
+
103
134
  ## Code of Conduct
104
135
 
105
136
  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.