Merge pull request #21 from forcedotcom/offlineAnalysis

Add Offline Analysis Tool for Mobile Web MCP

Author: haifeng-li-at-salesforce

.gitignore

@@ -19,7 +19,7 @@ coverage/
 Thumbs.db
 
 
-
+.sfdx/
 .cursor/rules/nx-rules.mdc
 .sfdx/
 .github/instructions/nx.instructions.md

package-lock.json

@@ -7,7 +7,7 @@
     "packages/*"
   ],
   "scripts": {
-    "prettier:format": "prettier --write \"**/src/**/*.{ts, js, md, json}\" \"**/tests/**/*.{ts, js, md, json}\"",
+    "prettier:format": "prettier --write \"**/src/**/*.{ts,js,md,json}\" \"**/tests/**/*.{ts,js,md,json}\" \"**/package.json\"",
     "prettier:verify": "prettier --list-different \"**/src/**/*.{ts, js, md, json}\"  \"**/tests/**/*.{ts, js, md, json}\"",
     "lint": "eslint \"**/*.{ts,tsx,js,jsx}\"",
     "test": "nx run-many --target=test",
@@ -33,12 +33,11 @@
     "@modelcontextprotocol/sdk": "^1.12.3"
   },
   "devDependencies": {
-    "@eslint/js": "^9.30.0",
     "@nx/workspace": "^21.2.1",
     "@types/node": "^24.0.10",
+    "eslint": "^9.30.0",
     "@vitest/coverage-v8": "^3.2.3",
     "@typescript-eslint/eslint-plugin": "^8.35.1",
-    "eslint": "^9.30.0",
     "eslint-config-prettier": "^10.1.5",
     "eslint-plugin-prettier": "^5.5.1",
     "husky": "^9.1.7",
@@ -49,8 +48,7 @@
     "tsx": "^4.19.2",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.35.1",
-    "vite": "^6.3.5",
-    "zod": "^3.25.67"
+    "vite": "^6.3.5"
   },
   "nx": {
     "extends": "@nx/workspace/presets/npm.json"

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@salesforce/mobile-mpc-tools-evaluation",
+  "name": "@salesforce/mobile-mcp-tools-evaluation",
   "version": "0.0.1",
   "type": "module",
   "files": [

packages/evaluation/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@salesforce/mobile-mpc-tools-evaluation",
+  "name": "@salesforce/mobile-mcp-tools-evaluation",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "sourceRoot": "packages/evaluation/src",
   "projectType": "library",

packages/evaluation/project.json

@@ -1,6 +1,7 @@
 {
   "name": "@salesforce/mobile-web-mcp-server",
   "version": "0.0.1",
+  "type": "module",
   "files": [
     "dist",
     "resources"
@@ -20,7 +21,11 @@
     "update-resources": "tsx src/scripts/update-type-declarations.ts"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.13.2"
+    "@modelcontextprotocol/sdk": "^1.13.2",
+    "eslint": "^9.30.0",
+    "dedent": "^1.5.3",
+    "zod": "^3.25.67",
+    "@salesforce/eslint-plugin-lwc-graph-analyzer": "^1.0.0"
   },
   "devDependencies": {
     "@modelcontextprotocol/inspector": "^0.15.0",

packages/mobile-web/package.json

@@ -9,20 +9,22 @@
 
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
-import { version } from '../package.json';
+import packageJson from '../package.json' with { type: 'json' };
+const version = packageJson.version;
 import { ToolAnnotations } from '@modelcontextprotocol/sdk/types.js';
 
-import { AppReviewTool } from './tools/appReview/tool.js';
-import { ArSpaceCaptureTool } from './tools/arSpaceCapture/tool.js';
-import { BarcodeScannerTool } from './tools/barcodeScanner/tool.js';
-import { BiometricsTool } from './tools/biometrics/tool.js';
-import { CalendarTool } from './tools/calendar/tool.js';
-import { ContactsTool } from './tools/contacts/tool.js';
-import { DocumentScannerTool } from './tools/documentScanner/tool.js';
-import { GeofencingTool } from './tools/geofencing/tool.js';
-import { LocationTool } from './tools/location/tool.js';
-import { NfcTool } from './tools/nfc/tool.js';
-import { PaymentsTool } from './tools/payments/tool.js';
+import { AppReviewTool } from './tools/native-capabilities/appReview/tool.js';
+import { ArSpaceCaptureTool } from './tools/native-capabilities/arSpaceCapture/tool.js';
+import { BarcodeScannerTool } from './tools/native-capabilities/barcodeScanner/tool.js';
+import { BiometricsTool } from './tools/native-capabilities/biometrics/tool.js';
+import { CalendarTool } from './tools/native-capabilities/calendar/tool.js';
+import { ContactsTool } from './tools/native-capabilities/contacts/tool.js';
+import { DocumentScannerTool } from './tools/native-capabilities/documentScanner/tool.js';
+import { GeofencingTool } from './tools/native-capabilities/geofencing/tool.js';
+import { LocationTool } from './tools/native-capabilities/location/tool.js';
+import { NfcTool } from './tools/native-capabilities/nfc/tool.js';
+import { PaymentsTool } from './tools/native-capabilities/payments/tool.js';
+import { OfflineAnalysisTool } from './tools/mobile-offline/offline-analysis/tool.js';
 
 const server = new McpServer({
   name: 'sfdc-mobile-web-mcp-server',
@@ -37,30 +39,23 @@ const annotations: ToolAnnotations = {
   openWorldHint: false,
 };
 
-// Create and register all tools
-const appReviewTool = new AppReviewTool(server, annotations);
-const arSpaceCaptureTool = new ArSpaceCaptureTool(server, annotations);
-const barcodeScannerTool = new BarcodeScannerTool(server, annotations);
-const biometricsTool = new BiometricsTool(server, annotations);
-const calendarTool = new CalendarTool(server, annotations);
-const contactsTool = new ContactsTool(server, annotations);
-const documentScanner = new DocumentScannerTool(server, annotations);
-const geofencingTool = new GeofencingTool(server, annotations);
-const locationTool = new LocationTool(server, annotations);
-const nfcTool = new NfcTool(server, annotations);
-const paymentsTool = new PaymentsTool(server, annotations);
+const tools = [
+  new AppReviewTool(),
+  new ArSpaceCaptureTool(),
+  new BarcodeScannerTool(),
+  new BiometricsTool(),
+  new CalendarTool(),
+  new ContactsTool(),
+  new DocumentScannerTool(),
+  new GeofencingTool(),
+  new LocationTool(),
+  new NfcTool(),
+  new PaymentsTool(),
+  new OfflineAnalysisTool(),
+];
 
-appReviewTool.register();
-arSpaceCaptureTool.register();
-barcodeScannerTool.register();
-biometricsTool.register();
-calendarTool.register();
-contactsTool.register();
-documentScanner.register();
-geofencingTool.register();
-locationTool.register();
-nfcTool.register();
-paymentsTool.register();
+// Register all tools
+tools.forEach(tool => tool.register(server, annotations));
 
 export default server;
 

packages/mobile-web/src/index.ts

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
+import { z } from 'zod';
+
+const ExpertReviewerNameSchema = z
+  .string()
+  .describe(
+    'The title-cased name of the reviewer providing the review instructions, representing a brief description of the functional area meant to be reviewed.'
+  );
+
+export const CodeAnalysisBaseIssueSchema = z.object({
+  type: z.string().describe('Categorize the issue'),
+  description: z.string().describe('Why this is an issue?'),
+  intentAnalysis: z.string().describe('What is the likely intent of the developer?'),
+  suggestedAction: z
+    .string()
+    .describe(
+      `How a developer should address the issue? Be as detailed as possible without adding code snippets.`
+    ),
+});
+
+export const CodeAnalysisIssueSchema = CodeAnalysisBaseIssueSchema.extend({
+  code: z.string().optional().describe('What is the code snippet with the issue?'),
+  location: z
+    .object({
+      startLine: z.number().gte(0),
+      endLine: z.number().gte(0).optional(),
+      startColumn: z.number().gte(0).optional(),
+      endColumn: z.number().gte(0).optional(),
+    })
+    .describe('Provide the exact line number(s) and column number(s) where the issue occurs'),
+});
+
+export const ExpertCodeAnalysisIssuesSchema = z.object({
+  expertReviewerName: ExpertReviewerNameSchema,
+  issues: z
+    .array(CodeAnalysisIssueSchema)
+    .describe(
+      'Specific issues found during the analysis. Should be empty if no issues were found.'
+    ),
+});
+
+export const ExpertsCodeAnalysisIssuesSchema = z.object({
+  analysisResults: z
+    .array(ExpertCodeAnalysisIssuesSchema)
+    .min(1)
+    .describe(
+      'An array of expert reviews of the code, each outlining specific issues found during analysis.'
+    ),
+  orchestrationInstructions: z
+    .string()
+    .default(
+      "If you have not already executed the 'sfmobile-web-offline-guidance' tool in this conversation thread: (1) Immediately call the 'sfmobile-web-offline-guidance' tool, (2) Execute all review instructions from the guidance tool's output against the user's LWC component code in the specified format, (3) Combine the review results from step 2 with this tool's analysis results, then refactor the component based on all combined review recommendations."
+    )
+    .describe(
+      'Instructions for the MCP client on how to orchestrate this tool with the companion guidance tool for comprehensive offline compatibility review.'
+    ),
+});
+
+export type CodeAnalysisIssueType = z.infer<typeof CodeAnalysisIssueSchema>;
+export type CodeAnalysisBaseIssueType = z.infer<typeof CodeAnalysisBaseIssueSchema>;
+export type ExpertCodeAnalysisIssuesType = z.infer<typeof ExpertCodeAnalysisIssuesSchema>;
+export type ExpertsCodeAnalysisIssuesType = z.infer<typeof ExpertsCodeAnalysisIssuesSchema>;

packages/mobile-web/src/schemas/analysisSchema.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
+import z from 'zod';
+
+export const EmptySchema = z.object({});
+
+const LwcFileSchema = z.object({
+  path: z.string().describe('path to component file relative to LWC component bundle root'),
+  content: z.string().describe('content of the file'),
+});
+
+export const LwcCodeSchema = z.object({
+  name: z.string().min(1).describe('Name of the LWC component'),
+  namespace: z.string().describe('Namespace of the LWC component').default('c'),
+  html: z.array(LwcFileSchema).min(1).describe('LWC component HTML templates.'),
+  js: z.array(LwcFileSchema).min(1).describe('LWC component JavaScript files.'),
+  css: z.array(LwcFileSchema).describe('LWC component CSS files.'),
+  jsMetaXml: LwcFileSchema.describe('LWC component configuration .js-meta.xml file.'),
+});
+
+export type LwcCodeType = z.TypeOf<typeof LwcCodeSchema>;

packages/mobile-web/src/schemas/lwcSchema.ts

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
+import { CodeAnalysisBaseIssueType } from '../../../schemas/analysisSchema.js';
+import dedent from 'dedent';
+
+export interface RuleConfig {
+  id: string; //ESLint rule id
+  config: CodeAnalysisBaseIssueType;
+}
+// ********** Rules: no-private-wire-config-property **********
+const NO_PRIVATE_WIRE_CONFIG_RULE_ID =
+  '@salesforce/lwc-graph-analyzer/no-private-wire-config-property';
+
+const noPrivateWireRule: CodeAnalysisBaseIssueType = {
+  type: 'Private Wire Configuration Property',
+  description:
+    'Properties used in wire configurations must be decorated with @api to be public and resolvable by the wire service.',
+  intentAnalysis:
+    'The developer used properties in wire configurations without making them public using the @api decorator.',
+
+  suggestedAction: dedent`
+        Make the properties public by using the @api decorator:
+        - Add @api decorator to properties used in wire configurations
+      `,
+};
+
+// ********** Rules: no-wire-config-references-non-local-property-reactive-value **********
+const NO_WIRE_CONFIG_REFERENCES_NON_LOCAL_PROPERTY_REACTIVE_VALUE_RULE_ID =
+  '@salesforce/lwc-graph-analyzer/no-wire-config-references-non-local-property-reactive-value';
+
+const noWireConfigReferenceNonLocalPropertyRule: CodeAnalysisBaseIssueType = {
+  type: 'Wire Configuration References Non-Local Property',
+  description:
+    'Wire configurations with reactive values ($prop) must reference only component properties, not imported values or values defined outside the component class.',
+  intentAnalysis:
+    'The developer is trying to use a non-local value (imported or module-level) as a reactive parameter in a wire configuration.',
+
+  suggestedAction: dedent`
+        Wrap the non-local value in a getter:
+        - Introduce a getter which returns the imported value or the value of a module-level constant
+        - Update the wire configuration to use the getter name as the reactive parameter
+        Example:
+            // Instead of:
+            @wire(getData, { param: importedValue })
+            
+            // Use:
+            get localValue() {
+                return importedValue;
+            }
+            @wire(getData, { param: '$localValue' })
+      `,
+};
+
+const noPrivateWireRuleConfig: RuleConfig = {
+  id: NO_PRIVATE_WIRE_CONFIG_RULE_ID,
+  config: noPrivateWireRule,
+};
+
+const noWireConfigReferenceNonLocalPropertyRuleConfig: RuleConfig = {
+  id: NO_WIRE_CONFIG_REFERENCES_NON_LOCAL_PROPERTY_REACTIVE_VALUE_RULE_ID,
+  config: noWireConfigReferenceNonLocalPropertyRule,
+};
+
+export const ruleConfigs: RuleConfig[] = [
+  noPrivateWireRuleConfig,
+  noWireConfigReferenceNonLocalPropertyRuleConfig,
+];