@W-21740433 - Add PFT telemetry support for Code Analyzer MCP tools

packages/mcp-provider-api/src/index.ts

@@ -14,6 +14,7 @@ export {
   type Services,
   type TelemetryService,
   type TelemetryEvent,
+  type PdpEvent,
   type OrgService,
   type ConfigService,
   type StartupFlags

packages/mcp-provider-api/src/services.ts

@@ -9,12 +9,20 @@ export interface Services {
 
 export interface TelemetryService {
   sendEvent(eventName: string, event: TelemetryEvent): void;
+  sendPdpEvent(event: PdpEvent): void;
 }
 
 export type TelemetryEvent = {
   [key: string]: string | number | boolean | null | undefined;
 };
 
+export type PdpEvent = {
+  eventName: `${string}.${string}`;
+  productFeatureId: `aJC${string}`;
+  componentId?: string;
+  eventVolume?: number;
+};
+
 
 export interface OrgService {
   getAllowedOrgUsernames(): Promise<Set<string>>;

packages/mcp-provider-code-analyzer/package.json

@@ -20,7 +20,7 @@
     "@salesforce/code-analyzer-pmd-engine": "^0.37.0",
     "@salesforce/code-analyzer-regex-engine": "^0.33.0",
     "@salesforce/code-analyzer-retirejs-engine": "^0.32.0",
-    "@salesforce/mcp-provider-api": "^0.4.1",
+    "@salesforce/mcp-provider-api": "^0.6.0",
     "fast-xml-parser": "^5.5.3",
     "zod": "^3.25.76"
   },

packages/mcp-provider-code-analyzer/src/constants.ts

@@ -1,6 +1,9 @@
 export const TelemetryEventName = "code-analyzer"
 export const TelemetrySource = "MCP"
 
+// Product Feature ID for PFT (Product Feedback Telemetry) events
+export const CODE_ANALYZER_PRODUCT_FEATURE_ID = "aJCEE0000000mDK4AY"
+
 export const McpTelemetryEvents = {
     ENGINE_SELECTION: 'engine_selection',
     ENGINE_EXECUTION: 'engine_execution',

packages/mcp-provider-code-analyzer/src/provider.ts

@@ -27,17 +27,17 @@ export class CodeAnalyzerMcpProvider extends McpProvider {
                 configFactory,
                 enginePluginsFactory,
                 telemetryService: services.getTelemetryService()
-            })),
+            }), services.getTelemetryService()),
             new CodeAnalyzerDescribeRuleMcpTool(new DescribeRuleActionImpl({
                 configFactory,
                 enginePluginsFactory,
                 telemetryService: services.getTelemetryService()
-            })),
+            }), services.getTelemetryService()),
             new CodeAnalyzerListRulesMcpTool(new ListRulesActionImpl({
                 configFactory,
                 enginePluginsFactory,
                 telemetryService: services.getTelemetryService()
-            })),
+            }), services.getTelemetryService()),
             new CodeAnalyzerQueryResultsMcpTool(new QueryResultsActionImpl(), services.getTelemetryService()),
             new GenerateXpathPromptMcpTool(new GetAstNodesActionImpl(), services.getTelemetryService()),
             new CreateCustomRuleMcpTool(new CreateXpathCustomRuleActionImpl(), services.getTelemetryService())

packages/mcp-provider-code-analyzer/src/tools/create_custom_rule.ts

@@ -117,6 +117,12 @@ export class CreateCustomRuleMcpTool extends McpTool<InputArgsShape, OutputArgsS
         rulesetPath: output.rulesetPath,
         configPath: output.configPath
       });
+      // Send PFT event for product analytics
+      this.telemetryService.sendPdpEvent({
+        eventName: 'codeAnalyzer.createCustomRule',
+        productFeatureId: Constants.CODE_ANALYZER_PRODUCT_FEATURE_ID,
+        componentId: CreateCustomRuleMcpTool.NAME
+      });
     }
     return {
       content: [{ type: "text", text: message }],

packages/mcp-provider-code-analyzer/src/tools/describe_code_analyzer_rule.ts

@@ -1,11 +1,12 @@
 import { z }  from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
-import { McpTool, McpToolConfig, ReleaseState, Services, Toolset } from "@salesforce/mcp-provider-api";
+import { McpTool, McpToolConfig, ReleaseState, Services, Toolset, TelemetryService } from "@salesforce/mcp-provider-api";
 import { DescribeRuleAction, DescribeRuleActionImpl, DescribeRuleInput, DescribeRuleOutput} from "../actions/describe-rule.js";
 import { CodeAnalyzerConfigFactoryImpl } from "../factories/CodeAnalyzerConfigFactory.js";
 import { EnginePluginsFactoryImpl } from "../factories/EnginePluginsFactory.js";
 import { getErrorMessage } from "../utils.js";
 import {CodeAnalyzerRunMcpTool} from "./run_code_analyzer.js";
+import * as Constants from "../constants.js";
 
 const DESCRIPTION: string = `A tool for getting the description of a Code Analyzer rule.
 This tool can return a JSON that describes the properties of a Code Analyzer rule, which may include information about
@@ -38,15 +39,18 @@ type OutputArgsShape = typeof outputSchema.shape;
 export class CodeAnalyzerDescribeRuleMcpTool extends McpTool<InputArgsShape, OutputArgsShape> {
     public static readonly NAME: string = 'describe_code_analyzer_rule';
     private readonly action: DescribeRuleAction;
+    private readonly telemetryService?: TelemetryService;
 
     public constructor(
         action: DescribeRuleAction = new DescribeRuleActionImpl({
             configFactory: new CodeAnalyzerConfigFactoryImpl(),
             enginePluginsFactory: new EnginePluginsFactoryImpl()
-        })
+        }),
+        telemetryService?: TelemetryService
     ) {
         super();
         this.action = action;
+        this.telemetryService = telemetryService;
     }
 
     public getReleaseState(): ReleaseState {
@@ -77,6 +81,14 @@ export class CodeAnalyzerDescribeRuleMcpTool extends McpTool<InputArgsShape, Out
         let output: DescribeRuleOutput;
         try {
             output = await this.action.exec(input);
+            // Send PFT event for product analytics
+            if (output.status === "success") {
+                this.telemetryService?.sendPdpEvent({
+                    eventName: 'codeAnalyzer.describeRule',
+                    productFeatureId: Constants.CODE_ANALYZER_PRODUCT_FEATURE_ID,
+                    componentId: CodeAnalyzerDescribeRuleMcpTool.NAME
+                });
+            }
         } catch (e) {
             output = { status: getErrorMessage(e) };
         }

packages/mcp-provider-code-analyzer/src/tools/generate_xpath_prompt.ts

@@ -119,6 +119,12 @@ export class GenerateXpathPromptMcpTool extends McpTool<InputArgsShape, OutputAr
         engine: input.engine,
         language: input.language
       });
+      // Send PFT event for product analytics
+      this.telemetryService.sendPdpEvent({
+        eventName: 'codeAnalyzer.generateXpathPrompt',
+        productFeatureId: Constants.CODE_ANALYZER_PRODUCT_FEATURE_ID,
+        componentId: 'get_ast_nodes_to_generate_xpath'
+      });
     }
     return buildToolResult(output);
   }

packages/mcp-provider-code-analyzer/src/tools/list_code_analyzer_rules.ts

@@ -1,11 +1,12 @@
 import {z} from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
-import {McpTool, ReleaseState, McpToolConfig, Toolset} from "@salesforce/mcp-provider-api";
+import {McpTool, ReleaseState, McpToolConfig, Toolset, TelemetryService} from "@salesforce/mcp-provider-api";
 import {ListRulesAction, ListRulesInput, ListRulesOutput, ListRulesActionImpl} from "../actions/list-rules.js";
 import {CodeAnalyzerConfigFactoryImpl} from "../factories/CodeAnalyzerConfigFactory.js";
 import {EnginePluginsFactoryImpl} from "../factories/EnginePluginsFactory.js";
 import {getErrorMessage} from "../utils.js";
 import { isFullListSelector, makePolicyError } from "../policies.js";
+import * as Constants from "../constants.js";
 import {
     ENGINE_NAMES,
     SEVERITY_NUMBERS,
@@ -83,6 +84,7 @@ type OutputArgsShape = typeof outputSchema.shape;
 export class CodeAnalyzerListRulesMcpTool extends McpTool<InputArgsShape, OutputArgsShape> {
     public static readonly NAME: string = 'list_code_analyzer_rules';
     private readonly action: ListRulesAction;
+    private readonly telemetryService?: TelemetryService;
 
     /**
      * Validates a selector string ensuring that each token (split on ',' and ':')
@@ -133,10 +135,12 @@ export class CodeAnalyzerListRulesMcpTool extends McpTool<InputArgsShape, Output
         action: ListRulesAction = new ListRulesActionImpl({
             configFactory: new CodeAnalyzerConfigFactoryImpl(),
             enginePluginsFactory: new EnginePluginsFactoryImpl()
-        })
+        }),
+        telemetryService?: TelemetryService
     ) {
         super();
         this.action = action;
+        this.telemetryService = telemetryService;
     }
 
     public getReleaseState(): ReleaseState {
@@ -193,6 +197,14 @@ export class CodeAnalyzerListRulesMcpTool extends McpTool<InputArgsShape, Output
         }
         try {
             output = await this.action.exec(input);
+            // Send PFT event for product analytics
+            if (output.status === "success") {
+                this.telemetryService?.sendPdpEvent({
+                    eventName: 'codeAnalyzer.listRules',
+                    productFeatureId: Constants.CODE_ANALYZER_PRODUCT_FEATURE_ID,
+                    componentId: CodeAnalyzerListRulesMcpTool.NAME
+                });
+            }
         } catch (e) {
             output = { status: getErrorMessage(e) }
         }

packages/mcp-provider-code-analyzer/src/tools/query_code_analyzer_results.ts

@@ -130,6 +130,12 @@ export class CodeAnalyzerQueryResultsMcpTool extends McpTool<InputArgsShape, Out
                 totalViolations: output.totalViolations ?? 0,
                 totalMatches: output.totalMatches ?? 0
             });
+            // Send PFT event for product analytics
+            this.telemetryService?.sendPdpEvent({
+                eventName: 'codeAnalyzer.query',
+                productFeatureId: Constants.CODE_ANALYZER_PRODUCT_FEATURE_ID,
+                componentId: CodeAnalyzerQueryResultsMcpTool.NAME
+            });
             const contentItems: { type: "text"; text: string }[] = [];
             if (truncated) {
                 contentItems.push({

packages/mcp-provider-code-analyzer/src/tools/run_code_analyzer.ts

@@ -1,13 +1,14 @@
 import fs from "node:fs";
 import { z }  from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
-import { McpTool, McpToolConfig, ReleaseState, Services, Toolset } from "@salesforce/mcp-provider-api";
+import { McpTool, McpToolConfig, ReleaseState, Services, Toolset, TelemetryService } from "@salesforce/mcp-provider-api";
 import { getMessage } from "../messages.js";
 import { getErrorMessage } from "../utils.js";
 import { RunAnalyzerAction, RunAnalyzerActionImpl, RunInput, RunOutput } from "../actions/run-analyzer.js";
 import { CodeAnalyzerListRulesMcpTool } from "./list_code_analyzer_rules.js";
 import { CodeAnalyzerConfigFactoryImpl } from "../factories/CodeAnalyzerConfigFactory.js";
 import { EnginePluginsFactoryImpl } from "../factories/EnginePluginsFactory.js";
+import * as Constants from "../constants.js";
 
 const MAX_ALLOWABLE_TARGET_COUNT = 10;
 
@@ -56,15 +57,18 @@ type OutputArgsShape = typeof outputSchema.shape;
 export class CodeAnalyzerRunMcpTool extends McpTool<InputArgsShape, OutputArgsShape> {
     public static readonly NAME: string = 'run_code_analyzer';
     private readonly action: RunAnalyzerAction;
+    private readonly telemetryService?: TelemetryService;
 
     public constructor(
         action: RunAnalyzerAction = new RunAnalyzerActionImpl({
             configFactory: new CodeAnalyzerConfigFactoryImpl(),
             enginePluginsFactory: new EnginePluginsFactoryImpl()
-        })
+        }),
+        telemetryService?: TelemetryService
     ) {
         super();
         this.action = action;
+        this.telemetryService = telemetryService;
     }
 
     public getReleaseState(): ReleaseState {
@@ -106,6 +110,14 @@ export class CodeAnalyzerRunMcpTool extends McpTool<InputArgsShape, OutputArgsSh
             }
 
             const output: RunOutput = await this.action.exec(input);
+            // Send PFT event for product analytics
+            if (output.status === "success" || output.resultsFile) {
+                this.telemetryService?.sendPdpEvent({
+                    eventName: 'codeAnalyzer.run',
+                    productFeatureId: Constants.CODE_ANALYZER_PRODUCT_FEATURE_ID,
+                    componentId: CodeAnalyzerRunMcpTool.NAME
+                });
+            }
             return {
                 content: [{ type: "text", text: JSON.stringify(output) }],
                 structuredContent: output

packages/mcp/src/services.ts

@@ -17,6 +17,7 @@ import {
   Services as IServices,
   TelemetryService,
   TelemetryEvent,
+  PdpEvent,
   OrgService,
   SanitizedOrgAuthorization,
   ConfigService,
@@ -70,4 +71,8 @@ class NoopTelemetryService implements TelemetryService {
   public sendEvent(_eventName: string, _event: TelemetryEvent): void {
     // no-op
   }
+
+  public sendPdpEvent(_event: PdpEvent): void {
+    // no-op
+  }
 }