refactor: update error messages in schema validations

cameroncooke · cameroncooke · commit 960b1ca070bd · 2026-01-01T12:45:37.000Z
Changes:
- Replaced 'error' keys with 'message' in Zod schema validations across multiple tools to standardize error handling and improve clarity.
- Updated validation messages for projectPath, workspacePath, simulatorId, and simulatorName to enhance user feedback.

This change ensures consistency in error messaging throughout the codebase, aligning with the latest Zod practices.
diff --git a/.smithery/index.cjs b/.smithery/index.cjs
diff --git a/src/mcp/tools/device/build_device.ts b/src/mcp/tools/device/build_device.ts
@@ -31,10 +31,10 @@ const buildDeviceSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/device/get_device_app_path.ts b/src/mcp/tools/device/get_device_app_path.ts
@@ -37,10 +37,10 @@ const getDeviceAppPathSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/device/install_app_device.ts b/src/mcp/tools/device/install_app_device.ts
@@ -19,7 +19,7 @@ import {
 const installAppDeviceSchema = z.object({
   deviceId: z
     .string()
-    .min(1, { error: 'Device ID cannot be empty' })
+    .min(1, { message: 'Device ID cannot be empty' })
     .describe('UDID of the device (obtained from list_devices)'),
   appPath: z
     .string()
diff --git a/src/mcp/tools/device/test_device.ts b/src/mcp/tools/device/test_device.ts
@@ -53,10 +53,10 @@ const testDeviceSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/macos/build_macos.ts b/src/mcp/tools/macos/build_macos.ts
@@ -60,10 +60,10 @@ const buildMacOSSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/macos/build_run_macos.ts b/src/mcp/tools/macos/build_run_macos.ts
@@ -51,10 +51,10 @@ const buildRunMacOSSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/macos/get_mac_app_path.ts b/src/mcp/tools/macos/get_mac_app_path.ts
@@ -46,10 +46,10 @@ const getMacosAppPathSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/macos/test_macos.ts b/src/mcp/tools/macos/test_macos.ts
@@ -61,10 +61,10 @@ const testMacosSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/project-discovery/list_schemes.ts b/src/mcp/tools/project-discovery/list_schemes.ts
@@ -27,10 +27,10 @@ const listSchemesSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/project-discovery/show_build_settings.ts b/src/mcp/tools/project-discovery/show_build_settings.ts
@@ -28,10 +28,10 @@ const showBuildSettingsSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/session-management/session_set_defaults.ts b/src/mcp/tools/session-management/session_set_defaults.ts
@@ -22,11 +22,11 @@ const baseSchema = z.object({
 
 const schemaObj = baseSchema
   .refine((v) => !(v.projectPath && v.workspacePath), {
-    error: 'projectPath and workspacePath are mutually exclusive',
+    message: 'projectPath and workspacePath are mutually exclusive',
     path: ['projectPath'],
   })
   .refine((v) => !(v.simulatorId && v.simulatorName), {
-    error: 'simulatorId and simulatorName are mutually exclusive',
+    message: 'simulatorId and simulatorName are mutually exclusive',
     path: ['simulatorId'],
   });
 
diff --git a/src/mcp/tools/simulator/build_run_sim.ts b/src/mcp/tools/simulator/build_run_sim.ts
@@ -69,16 +69,16 @@ const buildRunSimulatorSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     })
     .refine((val) => val.simulatorId !== undefined || val.simulatorName !== undefined, {
-      error: 'Either simulatorId or simulatorName is required.',
+      message: 'Either simulatorId or simulatorName is required.',
     })
     .refine((val) => !(val.simulatorId !== undefined && val.simulatorName !== undefined), {
-      error: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
+      message: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/simulator/build_sim.ts b/src/mcp/tools/simulator/build_sim.ts
@@ -67,16 +67,16 @@ const buildSimulatorSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     })
     .refine((val) => val.simulatorId !== undefined || val.simulatorName !== undefined, {
-      error: 'Either simulatorId or simulatorName is required.',
+      message: 'Either simulatorId or simulatorName is required.',
     })
     .refine((val) => !(val.simulatorId !== undefined && val.simulatorName !== undefined), {
-      error: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
+      message: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/simulator/get_sim_app_path.ts b/src/mcp/tools/simulator/get_sim_app_path.ts
@@ -120,16 +120,16 @@ const getSimulatorAppPathSchema = z.preprocess(
   nullifyEmptyStrings,
   baseGetSimulatorAppPathSchema
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     })
     .refine((val) => val.simulatorId !== undefined || val.simulatorName !== undefined, {
-      error: 'Either simulatorId or simulatorName is required.',
+      message: 'Either simulatorId or simulatorName is required.',
     })
     .refine((val) => !(val.simulatorId !== undefined && val.simulatorName !== undefined), {
-      error: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
+      message: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/simulator/launch_app_sim.ts b/src/mcp/tools/simulator/launch_app_sim.ts
@@ -32,10 +32,10 @@ const launchAppSimSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.simulatorId !== undefined || val.simulatorName !== undefined, {
-      error: 'Either simulatorId or simulatorName is required.',
+      message: 'Either simulatorId or simulatorName is required.',
     })
     .refine((val) => !(val.simulatorId !== undefined && val.simulatorName !== undefined), {
-      error: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
+      message: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/simulator/record_sim_video.ts b/src/mcp/tools/simulator/record_sim_video.ts
@@ -24,7 +24,7 @@ import { dirname } from 'path';
 // Base schema object (used for MCP schema exposure)
 const recordSimVideoSchemaObject = z.object({
   simulatorId: z
-    .uuid({ error: 'Invalid Simulator UUID format' })
+    .uuid({ message: 'Invalid Simulator UUID format' })
     .describe('UUID of the simulator to record'),
   start: z.boolean().optional().describe('Start recording if true'),
   stop: z.boolean().optional().describe('Stop recording if true'),
@@ -44,12 +44,13 @@ const recordSimVideoSchema = recordSimVideoSchemaObject
       return s + t === 1;
     },
     {
-      error: 'Provide exactly one of start=true or stop=true; these options are mutually exclusive',
+      message:
+        'Provide exactly one of start=true or stop=true; these options are mutually exclusive',
       path: ['start'],
     },
   )
   .refine((v) => (v.stop ? typeof v.outputFile === 'string' && v.outputFile.length > 0 : true), {
-    error: 'outputFile is required when stop=true',
+    message: 'outputFile is required when stop=true',
     path: ['outputFile'],
   });
 
diff --git a/src/mcp/tools/simulator/stop_app_sim.ts b/src/mcp/tools/simulator/stop_app_sim.ts
@@ -29,10 +29,10 @@ const stopAppSimSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.simulatorId !== undefined || val.simulatorName !== undefined, {
-      error: 'Either simulatorId or simulatorName is required.',
+      message: 'Either simulatorId or simulatorName is required.',
     })
     .refine((val) => !(val.simulatorId !== undefined && val.simulatorName !== undefined), {
-      error: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
+      message: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/simulator/test_sim.ts b/src/mcp/tools/simulator/test_sim.ts
@@ -71,16 +71,16 @@ const testSimulatorSchema = z.preprocess(
   nullifyEmptyStrings,
   baseSchemaObject
     .refine((val) => val.projectPath !== undefined || val.workspacePath !== undefined, {
-      error: 'Either projectPath or workspacePath is required.',
+      message: 'Either projectPath or workspacePath is required.',
     })
     .refine((val) => !(val.projectPath !== undefined && val.workspacePath !== undefined), {
-      error: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
+      message: 'projectPath and workspacePath are mutually exclusive. Provide only one.',
     })
     .refine((val) => val.simulatorId !== undefined || val.simulatorName !== undefined, {
-      error: 'Either simulatorId or simulatorName is required.',
+      message: 'Either simulatorId or simulatorName is required.',
     })
     .refine((val) => !(val.simulatorId !== undefined && val.simulatorName !== undefined), {
-      error: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
+      message: 'simulatorId and simulatorName are mutually exclusive. Provide only one.',
     }),
 );
 
diff --git a/src/mcp/tools/ui-testing/button.ts b/src/mcp/tools/ui-testing/button.ts
@@ -17,9 +17,9 @@ import {
 
 // Define schema as ZodObject
 const buttonSchema = z.object({
-  simulatorId: z.uuid({ error: 'Invalid Simulator UUID format' }),
+  simulatorId: z.uuid({ message: 'Invalid Simulator UUID format' }),
   buttonType: z.enum(['apple-pay', 'home', 'lock', 'side-button', 'siri']),
-  duration: z.number().min(0, { error: 'Duration must be non-negative' }).optional(),
+  duration: z.number().min(0, { message: 'Duration must be non-negative' }).optional(),
 });
 
 // Use z.infer for type safety
diff --git a/src/mcp/tools/ui-testing/describe_ui.ts b/src/mcp/tools/ui-testing/describe_ui.ts
@@ -17,7 +17,7 @@ import {
 
 // Define schema as ZodObject
 const describeUiSchema = z.object({
-  simulatorId: z.uuid({ error: 'Invalid Simulator UUID format' }),
+  simulatorId: z.uuid({ message: 'Invalid Simulator UUID format' }),
 });
 
 // Use z.infer for type safety
diff --git a/src/mcp/tools/ui-testing/gesture.ts b/src/mcp/tools/ui-testing/gesture.ts
@@ -29,7 +29,7 @@ import {
 
 // Define schema as ZodObject
 const gestureSchema = z.object({
-  simulatorId: z.uuid({ error: 'Invalid Simulator UUID format' }),
+  simulatorId: z.uuid({ message: 'Invalid Simulator UUID format' }),
   preset: z
     .enum([
       'scroll-up',
@@ -62,22 +62,22 @@ const gestureSchema = z.object({
     ),
   duration: z
     .number()
-    .min(0, { error: 'Duration must be non-negative' })
+    .min(0, { message: 'Duration must be non-negative' })
     .optional()
     .describe('Optional: Duration of the gesture in seconds.'),
   delta: z
     .number()
-    .min(0, { error: 'Delta must be non-negative' })
+    .min(0, { message: 'Delta must be non-negative' })
     .optional()
     .describe('Optional: Distance to move in pixels.'),
   preDelay: z
     .number()
-    .min(0, { error: 'Pre-delay must be non-negative' })
+    .min(0, { message: 'Pre-delay must be non-negative' })
     .optional()
     .describe('Optional: Delay before starting the gesture in seconds.'),
   postDelay: z
     .number()
-    .min(0, { error: 'Post-delay must be non-negative' })
+    .min(0, { message: 'Post-delay must be non-negative' })
     .optional()
     .describe('Optional: Delay after completing the gesture in seconds.'),
 });
diff --git a/src/mcp/tools/ui-testing/key_press.ts b/src/mcp/tools/ui-testing/key_press.ts
@@ -22,9 +22,9 @@ import {
 
 // Define schema as ZodObject
 const keyPressSchema = z.object({
-  simulatorId: z.uuid({ error: 'Invalid Simulator UUID format' }),
-  keyCode: z.number().int({ error: 'HID keycode to press (0-255)' }).min(0).max(255),
-  duration: z.number().min(0, { error: 'Duration must be non-negative' }).optional(),
+  simulatorId: z.uuid({ message: 'Invalid Simulator UUID format' }),
+  keyCode: z.number().int({ message: 'HID keycode to press (0-255)' }).min(0).max(255),
+  duration: z.number().min(0, { message: 'Duration must be non-negative' }).optional(),
 });
 
 // Use z.infer for type safety
diff --git a/src/mcp/tools/ui-testing/key_sequence.ts b/src/mcp/tools/ui-testing/key_sequence.ts
@@ -28,11 +28,11 @@ import {
 
 // Define schema as ZodObject
 const keySequenceSchema = z.object({
-  simulatorId: z.uuid({ error: 'Invalid Simulator UUID format' }),
+  simulatorId: z.uuid({ message: 'Invalid Simulator UUID format' }),
   keyCodes: z
     .array(z.number().int().min(0).max(255))
-    .min(1, { error: 'At least one key code required' }),
-  delay: z.number().min(0, { error: 'Delay must be non-negative' }).optional(),
+    .min(1, { message: 'At least one key code required' }),
+  delay: z.number().min(0, { message: 'Delay must be non-negative' }).optional(),
 });
 
 // Use z.infer for type safety
diff --git a/src/mcp/tools/ui-testing/long_press.ts b/src/mcp/tools/ui-testing/long_press.ts
@@ -29,10 +29,10 @@ import {
 
 // Define schema as ZodObject
 const longPressSchema = z.object({
-  simulatorId: z.uuid({ error: 'Invalid Simulator UUID format' }),
-  x: z.number().int({ error: 'X coordinate for the long press' }),
-  y: z.number().int({ error: 'Y coordinate for the long press' }),
-  duration: z.number().positive({ error: 'Duration of the long press in milliseconds' }),
+  simulatorId: z.uuid({ message: 'Invalid Simulator UUID format' }),
+  x: z.number().int({ message: 'X coordinate for the long press' }),
+  y: z.number().int({ message: 'Y coordinate for the long press' }),
+  duration: z.number().positive({ message: 'Duration of the long press in milliseconds' }),
 });
 
 // Use z.infer for type safety
diff --git a/src/mcp/tools/ui-testing/screenshot.ts b/src/mcp/tools/ui-testing/screenshot.ts
@@ -22,7 +22,7 @@ const LOG_PREFIX = '[Screenshot]';
 
 // Define schema as ZodObject
 const screenshotSchema = z.object({
-  simulatorId: z.uuid({ error: 'Invalid Simulator UUID format' }),
+  simulatorId: z.uuid({ message: 'Invalid Simulator UUID format' }),
 });
 
 // Use z.infer for type safety
diff --git a/src/mcp/tools/ui-testing/swipe.ts b/src/mcp/tools/ui-testing/swipe.ts
diff --git a/src/mcp/tools/ui-testing/tap.ts b/src/mcp/tools/ui-testing/tap.ts
diff --git a/src/mcp/tools/ui-testing/touch.ts b/src/mcp/tools/ui-testing/touch.ts
diff --git a/src/mcp/tools/ui-testing/type_text.ts b/src/mcp/tools/ui-testing/type_text.ts
diff --git a/src/utils/__tests__/session-aware-tool-factory.test.ts b/src/utils/__tests__/session-aware-tool-factory.test.ts
