Remove no telemetry flag, add unit tests

Author: allison-grady

packages/b2c-dx-mcp/README.md

@@ -16,9 +16,17 @@ The server automatically detects your project type and enables relevant tools. S
 
 The most important flag is **`--working-directory`** (or env var `SFCC_WORKING_DIRECTORY`). It tells the server where your project is located, enabling:
 
+<<<<<<< HEAD
 1. **Auto-discovery** - Detects your project type and enables appropriate toolsets
 2. **Configuration loading** - Reads [`dw.json`](https://salesforcecommercecloud.github.io/b2c-developer-tooling/guide/configuration.html#configuration-file) from your project for credentials
 3. **Scaffolding** - Creates new files in the correct location
+=======
+| 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 |
+>>>>>>> 1ca55c6 (Remove no telemetry flag, add unit tests)
 
 > **Important:** MCP clients like Cursor and Claude Desktop spawn servers from the home directory (`~`), not your project. Always set `--working-directory`.
 
@@ -327,6 +335,227 @@ echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | node bin/dev.js --toolse
 echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"cartridge_deploy","arguments":{}}}' | node bin/dev.js --toolsets all --allow-non-ga-tools
 ```
 
+### Configuration
+
+> **Note:** Configuration is not currently required as all tools are placeholder implementations. This section will be relevant once tools are fully implemented.
+
+Different tools require different types of configuration:
+
+| Tool Type | Configuration Required |
+|-----------|----------------------|
+| **MRT tools** (e.g., `mrt_bundle_push`) | API key + project |
+| **B2C instance tools** (e.g., `cartridge_deploy`) | dw.json or instance flags |
+| **Local tools** (e.g., scaffolding) | None |
+
+#### MRT Configuration
+
+MRT tools require an **API key** and **project**. The **environment** is optional (for deployments).
+
+| Setting | Flag | Env Variable | Fallback |
+|---------|------|--------------|----------|
+| API key | `--api-key` | `SFCC_MRT_API_KEY` | `~/.mobify` |
+| Project | `--project` | `SFCC_MRT_PROJECT` | — |
+| Environment | `--environment` | `SFCC_MRT_ENVIRONMENT` | — |
+
+> Priority: Flag > Env variable > `~/.mobify` file
+
+**Example:**
+
+```json
+{
+  "mcpServers": {
+    "b2c-dx": {
+      "command": "/path/to/packages/b2c-dx-mcp/bin/dev.js",
+      "args": [
+        "--toolsets", "MRT",
+        "--project", "my-project",
+        "--environment", "staging",
+        "--api-key", "your-api-key"
+      ]
+    }
+  }
+}
+```
+
+Or use environment variables instead of flags:
+
+```json
+{
+  "mcpServers": {
+    "b2c-dx": {
+      "command": "/path/to/packages/b2c-dx-mcp/bin/dev.js",
+      "args": ["--toolsets", "MRT"],
+      "env": {
+        "SFCC_MRT_API_KEY": "your-api-key",
+        "SFCC_MRT_PROJECT": "my-project",
+        "SFCC_MRT_ENVIRONMENT": "staging"
+      }
+    }
+  }
+}
+```
+
+> **Note:** Make sure the script is executable: `chmod +x /path/to/packages/b2c-dx-mcp/bin/dev.js`
+
+#### Environment-Specific Config
+
+If you have a `~/.mobify` file from the `b2c` CLI, the MCP server will use it as a fallback for API key:
+
+```json
+{
+  "api_key": "your-api-key"
+}
+```
+
+For non-production environments, use `--cloud-origin` to select an environment-specific config file:
+
+| `--cloud-origin` | Config File |
+|------------------|-------------|
+| (not set) | `~/.mobify` |
+| `https://cloud-staging.mobify.com` | `~/.mobify--cloud-staging.mobify.com` |
+| `https://cloud-dev.mobify.com` | `~/.mobify--cloud-dev.mobify.com` |
+
+#### B2C Instance Config (dw.json)
+
+Tools that interact with B2C Commerce instances (e.g., `cartridge_deploy`, SCAPI tools) require instance credentials.
+
+**Authentication Methods:**
+
+| Method | Credentials | Used By |
+|--------|-------------|---------|
+| **Basic auth** | `--username` + `--password` | WebDAV tools (`cartridge_deploy`) |
+| **OAuth** | `--client-id` + `--client-secret` | OCAPI tools, SCAPI tools |
+
+> **Recommendation:** Use Basic auth (username/password) for WebDAV tools like `cartridge_deploy`. OAuth credentials (client-id/client-secret) are required for OCAPI/SCAPI tools. If you need both WebDAV and OCAPI tools, configure all four credentials.
+
+**Priority order** (highest to lowest):
+
+1. Flags (`--server`, `--username`, `--password`, `--client-id`, `--client-secret`)
+2. Environment variables (`SFCC_*`)
+3. `dw.json` file (via `--config` flag or auto-discovery)
+
+**Option A: Flags with Basic auth (for WebDAV tools like cartridge_deploy)**
+
+```json
+{
+  "mcpServers": {
+    "b2c-dx": {
+      "command": "/path/to/packages/b2c-dx-mcp/bin/dev.js",
+      "args": [
+        "--toolsets", "CARTRIDGES",
+        "--server", "your-sandbox.demandware.net",
+        "--username", "your.username",
+        "--password", "your-access-key"
+      ]
+    }
+  }
+}
+```
+
+**Option B: Flags with OAuth (for OCAPI/SCAPI tools, or WebDAV fallback)**
+
+```json
+{
+  "mcpServers": {
+    "b2c-dx": {
+      "command": "/path/to/packages/b2c-dx-mcp/bin/dev.js",
+      "args": [
+        "--toolsets", "SCAPI",
+        "--server", "your-sandbox.demandware.net",
+        "--client-id", "your-client-id",
+        "--client-secret", "your-client-secret"
+      ]
+    }
+  }
+}
+```
+
+**Option C: Environment variables (all credentials)**
+
+```json
+{
+  "mcpServers": {
+    "b2c-dx": {
+      "command": "/path/to/packages/b2c-dx-mcp/bin/dev.js",
+      "args": ["--toolsets", "CARTRIDGES"],
+      "env": {
+        "SFCC_SERVER": "your-sandbox.demandware.net",
+        "SFCC_USERNAME": "your.username",
+        "SFCC_PASSWORD": "your-access-key",
+        "SFCC_CLIENT_ID": "your-client-id",
+        "SFCC_CLIENT_SECRET": "your-client-secret",
+        "SFCC_CODE_VERSION": "version1"
+      }
+    }
+  }
+}
+```
+
+**Option D: dw.json with explicit path**
+
+```json
+{
+  "mcpServers": {
+    "b2c-dx": {
+      "command": "/path/to/packages/b2c-dx-mcp/bin/dev.js",
+      "args": ["--toolsets", "CARTRIDGES", "--config", "/path/to/dw.json"]
+    }
+  }
+}
+```
+
+**Option E: dw.json with auto-discovery**
+
+When `--config` is not provided, the MCP server searches upward from `~/` for a `dw.json` file.
+
+> **Note:** Auto-discovery starts from the home directory, so it won't find project-level `dw.json` files. Use `--config` with an explicit path instead.
+
+```json
+{
+  "hostname": "your-sandbox.demandware.net",
+  "username": "your.username",
+  "password": "your-access-key",
+  "client-id": "your-client-id",
+  "client-secret": "your-client-secret",
+  "code-version": "version1"
+}
+```
+
+> **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 |
@@ -211,11 +215,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,
-    }),
   };
 
   /**
@@ -288,9 +287,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);
+    });
+  });
 });