Remove no telemetry flag, add unit tests

Author: allison-grady

packages/b2c-dx-mcp/README.md

@@ -20,11 +20,11 @@ npm install -g @salesforce/b2c-dx-mcp
 
 #### MCP-Specific Flags
 
-| Flag | Description |
-|------|-------------|
-| `--toolsets` | Comma-separated toolsets to enable (case-insensitive) |
-| `--tools` | Comma-separated individual tools to enable (case-insensitive) |
-| `--allow-non-ga-tools` | Enable experimental (non-GA) tools |
+| Flag | Env Variable | Description |
+|------|--------------|-------------|
+| `--toolsets` | `SFCC_TOOLSETS` | Comma-separated toolsets to enable (case-insensitive) |
+| `--tools` | `SFCC_TOOLS` | Comma-separated individual tools to enable (case-insensitive) |
+| `--allow-non-ga-tools` | `SFCC_ALLOW_NON_GA_TOOLS` | Enable experimental (non-GA) tools |
 
 #### MRT Flags (inherited from MrtCommand)
 
@@ -521,6 +521,39 @@ When `--config` is not provided, the MCP server searches upward from `~/` for a
 
 > **Note:** Flags override environment variables, and environment variables override `dw.json`. You can mix sources (e.g., secrets via env vars, other settings via dw.json).
 
+## Telemetry
+
+The MCP server collects anonymous usage telemetry to help improve the developer experience. Telemetry is enabled by default and can be disabled by setting the `SFCC_TELEMETRY` environment variable to `false`.
+
+### What We Collect
+
+- **Server lifecycle events**: When the server starts, stops, or encounters errors
+- **Tool usage**: Which tools are called and their execution time (not the arguments or results)
+- **Environment info**: Platform, architecture, Node.js version, and package version
+
+### What We Don't Collect
+
+- **No credentials**: No API keys, passwords, or secrets
+- **No business data**: No product data, customer information, or site content
+- **No tool arguments**: No input parameters or output results from tool calls
+- **No file contents**: No source code, configuration files, or project data
+
+### Disabling Telemetry
+
+Set the `SFCC_TELEMETRY` environment variable to `false`:
+
+```json
+{
+  "mcpServers": {
+    "b2c-dx": {
+      "command": "/path/to/packages/b2c-dx-mcp/bin/dev.js",
+      "args": ["--toolsets", "all"],
+      "env": { "SFCC_TELEMETRY": "false" }
+    }
+  }
+}
+```
+
 ## License
 
 Apache-2.0

packages/b2c-dx-mcp/src/commands/mcp.ts

@@ -19,7 +19,11 @@
  * | `--toolsets` | `SFCC_TOOLSETS` | Comma-separated toolsets to enable (case-insensitive) |
  * | `--tools` | `SFCC_TOOLS` | Comma-separated individual tools to enable (case-insensitive) |
  * | `--allow-non-ga-tools` | `SFCC_ALLOW_NON_GA_TOOLS` | Enable experimental/non-GA tools |
- * | `--no-telemetry` | `SFCC_NO_TELEMETRY` | Disable telemetry collection |
+ *
+ * ### Environment Variables (no flag equivalent)
+ * | Env Variable | Description |
+ * |--------------|-------------|
+ * | `SFCC_TELEMETRY` | Set to `false` to disable telemetry collection |
  *
  * ### MRT Flags (from MrtCommand.baseFlags)
  * | Flag | Env Variable | Description |
@@ -202,11 +206,6 @@ export default class McpServerCommand extends BaseCommand<typeof McpServerComman
       env: 'SFCC_ALLOW_NON_GA_TOOLS',
       default: false,
     }),
-    'no-telemetry': Flags.boolean({
-      description: 'Disable telemetry collection',
-      env: 'SFCC_NO_TELEMETRY',
-      default: false,
-    }),
   };
 
   /**
@@ -247,9 +246,9 @@ export default class McpServerCommand extends BaseCommand<typeof McpServerComman
       workingDirectory: this.flags['working-directory'],
     };
 
-    // Initialize telemetry unless disabled
+    // Initialize telemetry unless disabled via SFCC_TELEMETRY=false
     let telemetry: Telemetry | undefined;
-    if (!this.flags['no-telemetry']) {
+    if (process.env.SFCC_TELEMETRY !== 'false') {
       telemetry = createTelemetry({
         project: 'b2c-dx-mcp',
         appInsightsKey: loadAppInsightsKey(),

packages/b2c-dx-mcp/test/commands/mcp.test.ts

@@ -35,6 +35,13 @@ describe('McpServerCommand', () => {
       expect(flag.default).to.equal(false);
     });
 
+    it('should not have a no-telemetry flag (telemetry controlled via SFCC_TELEMETRY env var only)', () => {
+      // Telemetry is disabled via SFCC_TELEMETRY=false env var, not a CLI flag
+      // This keeps the CLI cleaner and prevents accidental disabling
+      const flags = McpServerCommand.flags as Record<string, unknown>;
+      expect(flags['no-telemetry']).to.be.undefined;
+    });
+
     it('should inherit config flag from BaseCommand', () => {
       // config flag is inherited from BaseCommand.baseFlags
       const flag = McpServerCommand.baseFlags.config;

packages/b2c-dx-mcp/test/config.test.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+import {expect} from 'chai';
+import {APPLICATION_INSIGHTS_CONNECTION_STRING} from '../src/config.js';
+
+describe('config', () => {
+  describe('APPLICATION_INSIGHTS_CONNECTION_STRING', () => {
+    it('should export a non-empty connection string', () => {
+      expect(APPLICATION_INSIGHTS_CONNECTION_STRING).to.be.a('string');
+      expect(APPLICATION_INSIGHTS_CONNECTION_STRING.length).to.be.greaterThan(0);
+    });
+
+    it('should contain InstrumentationKey', () => {
+      expect(APPLICATION_INSIGHTS_CONNECTION_STRING).to.include('InstrumentationKey=');
+    });
+
+    it('should contain IngestionEndpoint', () => {
+      expect(APPLICATION_INSIGHTS_CONNECTION_STRING).to.include('IngestionEndpoint=');
+    });
+  });
+});

packages/b2c-dx-mcp/test/server.test.ts

@@ -7,6 +7,33 @@
 import {expect} from 'chai';
 import {z} from 'zod';
 import {B2CDxMcpServer} from '../src/server.js';
+import type {Telemetry} from '@salesforce/b2c-tooling-sdk/telemetry';
+
+/**
+ * Mock telemetry for testing.
+ */
+class MockTelemetry {
+  public attributes: Record<string, unknown> = {};
+  public events: Array<{name: string; attributes: Record<string, unknown>}> = [];
+  public started = false;
+  public stopped = false;
+
+  addAttributes(attrs: Record<string, unknown>): void {
+    this.attributes = {...this.attributes, ...attrs};
+  }
+
+  sendEvent(name: string, attributes: Record<string, unknown> = {}): void {
+    this.events.push({name, attributes});
+  }
+
+  async start(): Promise<void> {
+    this.started = true;
+  }
+
+  stop(): void {
+    this.stopped = true;
+  }
+}
 
 // Handlers extracted to module scope to reduce callback nesting depth
 const simpleHandler = async () => ({content: [{type: 'text' as const, text: 'ok'}]});
@@ -79,4 +106,30 @@ describe('B2CDxMcpServer', () => {
       expect(server.isConnected()).to.be.false;
     });
   });
+
+  describe('telemetry integration', () => {
+    it('should accept telemetry in options', () => {
+      const mockTelemetry = new MockTelemetry();
+
+      const server = new B2CDxMcpServer(
+        {name: 'test-server', version: '1.0.0'},
+        {telemetry: mockTelemetry as unknown as Telemetry},
+      );
+
+      expect(server).to.be.instanceOf(B2CDxMcpServer);
+    });
+
+    it('should work without telemetry (telemetry disabled)', () => {
+      // When telemetry is undefined, server should still work
+      const server = new B2CDxMcpServer({name: 'test-server', version: '1.0.0'}, {telemetry: undefined});
+
+      expect(server).to.be.instanceOf(B2CDxMcpServer);
+    });
+
+    it('should create server without options (no telemetry)', () => {
+      const server = new B2CDxMcpServer({name: 'test-server', version: '1.0.0'});
+
+      expect(server).to.be.instanceOf(B2CDxMcpServer);
+    });
+  });
 });

packages/b2c-dx-mcp/test/utils/index.test.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+import {expect} from 'chai';
+import {loadAppInsightsKey} from '../../src/utils/index.js';
+
+describe('utils', () => {
+  describe('loadAppInsightsKey', () => {
+    it('should return a connection string', () => {
+      const key = loadAppInsightsKey();
+      expect(key).to.be.a('string');
+    });
+
+    it('should return a string containing InstrumentationKey', () => {
+      const key = loadAppInsightsKey();
+      expect(key).to.include('InstrumentationKey=');
+    });
+
+    it('should return a valid Application Insights connection string format', () => {
+      const key = loadAppInsightsKey();
+      // Connection string should have key=value pairs separated by semicolons
+      expect(key).to.match(/InstrumentationKey=[^;]+/);
+      expect(key).to.match(/IngestionEndpoint=[^;]+/);
+    });
+  });
+});