appium-mcp 1.7.5 → 1.8.1

package/src/tools/context/switch-context.ts

@@ -1,6 +1,11 @@
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { FastMCP } from 'fastmcp';
 import { z } from 'zod';
-import { getDriver, getPlatformName, PLATFORM } from '../../session-store.js';
+import {
+  getDriver,
+  getPlatformName,
+  isRemoteDriverSession,
+  PLATFORM,
+} from '../../session-store.js';
 
 export default function switchContext(server: FastMCP): void {
   const schema = z.object({
@@ -26,10 +31,16 @@ export default function switchContext(server: FastMCP): void {
         throw new Error('No driver found. Please create a session first.');
       }
 
+      if (isRemoteDriverSession(driver)) {
+        throw new Error(
+          'Get context is not yet implemented for the remote driver'
+        );
+      }
+
       try {
         const [currentContext, availableContexts] = await Promise.all([
-          driver.getCurrentContext().catch(() => null),
-          driver.getContexts().catch(() => []),
+          (driver as any).getCurrentContext().catch(() => null),
+          (driver as any).getContexts().catch(() => []),
         ]);
 
         if (currentContext === args.context) {
@@ -66,10 +77,10 @@ export default function switchContext(server: FastMCP): void {
             isError: true,
           };
         }
-        await driver.switchContext(args.context);
+        await (driver as any).switchContext(args.context);
 
         // Verify the switch was successful
-        const newContext = await driver.getCurrentContext();
+        const newContext = await (driver as any).getCurrentContext();
 
         return {
           content: [

package/src/tools/index.ts

@@ -12,7 +12,7 @@
  * See src/tools/README.md for tool organization.
  * See src/tools/metadata/README.md for YAML metadata approach.
  */
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { FastMCP } from 'fastmcp';
 import log from '../logger.js';
 import answerAppium from './documentation/answer-appium.js';
 import createSession from './session/create-session.js';

package/src/tools/interactions/click.ts

@@ -1,7 +1,8 @@
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { FastMCP } from 'fastmcp';
 import { z } from 'zod';
-import { getDriver } from '../../session-store.js';
+import { getDriver, isRemoteDriverSession } from '../../session-store.js';
 import { elementUUIDScheme } from '../../schema.js';
+import type { Client } from 'webdriver';
 
 export default function generateTest(server: FastMCP): void {
   const clickActionSchema = z.object({
@@ -23,7 +24,9 @@ export default function generateTest(server: FastMCP): void {
       }
 
       try {
-        await driver.click(args.elementUUID);
+        const _ok = isRemoteDriverSession(driver)
+          ? await (driver as Client).elementClick(args.elementUUID)
+          : await (driver as any).click(args.elementUUID);
         return {
           content: [
             {

package/src/tools/interactions/double-tap.ts

@@ -1,7 +1,12 @@
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { FastMCP } from 'fastmcp';
 import { z } from 'zod';
-import { getDriver, getPlatformName } from '../../session-store.js';
+import {
+  getDriver,
+  getPlatformName,
+  isRemoteDriverSession,
+} from '../../session-store.js';
 import { elementUUIDScheme } from '../../schema.js';
+import type { Client } from 'webdriver';
 
 export default function doubleTap(server: FastMCP): void {
   const doubleTapActionSchema = z.object({
@@ -27,7 +32,10 @@ export default function doubleTap(server: FastMCP): void {
 
         if (platform === 'Android') {
           // Get element location for Android double tap
-          const element = await driver.findElement('id', args.elementUUID);
+          const element = await (driver as any).findElement(
+            'id',
+            args.elementUUID
+          );
           const location = await element.getLocation();
           const size = await element.getSize();
 
@@ -36,7 +44,7 @@ export default function doubleTap(server: FastMCP): void {
           const y = location.y + size.height / 2;
 
           // Perform double tap using performActions
-          await driver.performActions([
+          await (driver as any).performActions([
             {
               type: 'pointer',
               id: 'finger1',
@@ -55,9 +63,13 @@ export default function doubleTap(server: FastMCP): void {
           ]);
         } else if (platform === 'iOS') {
           // Use iOS mobile: doubleTap execute method
-          await driver.execute('mobile: doubleTap', [
-            { elementId: args.elementUUID },
-          ]);
+          const _ok = isRemoteDriverSession(driver)
+            ? await (driver as Client).executeScript('mobile: doubleTap', [
+                { elementId: args.elementUUID },
+              ])
+            : await (driver as any).execute('mobile: doubleTap', [
+                { elementId: args.elementUUID },
+              ]);
         } else {
           throw new Error(
             `Unsupported platform: ${platform}. Only Android and iOS are supported.`

package/src/tools/interactions/drag-and-drop.ts

@@ -1,7 +1,12 @@
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { FastMCP } from 'fastmcp';
 import { z } from 'zod';
-import { getDriver, getPlatformName } from '../../session-store.js';
+import {
+  getDriver,
+  getPlatformName,
+  isRemoteDriverSession,
+} from '../../session-store.js';
 import { elementUUIDScheme } from '../../schema.js';
+import type { Client } from 'webdriver';
 
 const DROP_PAUSE_DURATION_MS = 150;
 
@@ -108,13 +113,13 @@ export default function dragAndDrop(server: FastMCP): void {
       1. Long press (default 600ms, configurable) on the source to initiate drag mode
       2. While holding, drag to the target location
       3. Release at the target to complete the drop
-      
+
       Supports four modes:
       1. Element to Element: Drag from one element to another element
       2. Element to Coordinates: Drag from an element to specific coordinates
       3. Coordinates to Element: Drag from coordinates to an element
       4. Coordinates to Coordinates: Drag from coordinates to coordinates
-      
+
       This is useful for reordering lists, moving items, drag-to-delete, and other drag interactions.`,
     parameters: dragAndDropSchema,
     annotations: {
@@ -154,7 +159,9 @@ export default function dragAndDrop(server: FastMCP): void {
         let endX: number, endY: number;
 
         if (args.sourceElementUUID) {
-          const rect = await driver.getElementRect(args.sourceElementUUID);
+          const rect = await (driver as any).getElementRect(
+            args.sourceElementUUID
+          );
           startX = Math.floor(rect.x + rect.width / 2);
           startY = Math.floor(rect.y + rect.height / 2);
         } else {
@@ -163,7 +170,9 @@ export default function dragAndDrop(server: FastMCP): void {
         }
 
         if (args.targetElementUUID) {
-          const rect = await driver.getElementRect(args.targetElementUUID);
+          const rect = await (driver as any).getElementRect(
+            args.targetElementUUID
+          );
           endX = Math.floor(rect.x + rect.width / 2);
           endY = Math.floor(rect.y + rect.height / 2);
         } else {
@@ -171,7 +180,7 @@ export default function dragAndDrop(server: FastMCP): void {
           endY = args.targetY;
         }
 
-        const { width, height } = await driver.getWindowSize();
+        const { width, height } = await (driver as any).getWindowRect();
         if (startX < 0 || startX >= width || startY < 0 || startY >= height) {
           throw new Error(
             `Source coordinates (${startX}, ${startY}) are out of screen bounds (${width}x${height})`

package/src/tools/interactions/find.ts

@@ -1,4 +1,4 @@
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { FastMCP } from 'fastmcp';
 import { z } from 'zod';
 import { getDriver } from '../../session-store.js';
 
@@ -34,7 +34,10 @@ export default function findElement(server: FastMCP): void {
       }
 
       try {
-        const element = await driver.findElement(args.strategy, args.selector);
+        const element = await (driver as any).findElement(
+          args.strategy,
+          args.selector
+        );
         return {
           content: [
             {

package/src/tools/interactions/get-page-source.ts

@@ -1,4 +1,4 @@
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { FastMCP } from 'fastmcp';
 import { z } from 'zod';
 import { getDriver } from '../../session-store.js';
 import {
@@ -23,7 +23,7 @@ export default function getPageSource(server: FastMCP): void {
       }
 
       try {
-        const pageSource = await driver.getPageSource();
+        const pageSource = await (driver as any).getPageSource();
 
         if (!pageSource) {
           throw new Error('Page source is empty or null');

package/src/tools/interactions/get-text.ts

@@ -1,7 +1,8 @@
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { FastMCP } from 'fastmcp';
 import { z } from 'zod';
-import { getDriver } from '../../session-store.js';
+import { getDriver, isRemoteDriverSession } from '../../session-store.js';
 import { elementUUIDScheme } from '../../schema.js';
+import type { Client } from 'webdriver';
 
 export default function getText(server: FastMCP): void {
   const getTextSchema = z.object({
@@ -23,7 +24,9 @@ export default function getText(server: FastMCP): void {
       }
 
       try {
-        const text = await driver.getText(args.elementUUID);
+        const text = isRemoteDriverSession(driver)
+          ? await (driver as Client).getElementText(args.elementUUID)
+          : await (driver as any).getText(args.elementUUID);
         return {
           content: [
             {

package/src/tools/interactions/long-press.ts

@@ -1,7 +1,12 @@
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { FastMCP } from 'fastmcp';
 import { z } from 'zod';
-import { getDriver, getPlatformName } from '../../session-store.js';
+import {
+  getDriver,
+  getPlatformName,
+  isRemoteDriverSession,
+} from '../../session-store.js';
 import { elementUUIDScheme } from '../../schema.js';
+import type { Client } from 'webdriver';
 
 export default function longPress(server: FastMCP): void {
   const longPressSchema = z.object({
@@ -37,11 +42,11 @@ export default function longPress(server: FastMCP): void {
         const duration = args.duration || 2000;
 
         if (platform === 'Android') {
-          const rect = await driver.getElementRect(args.elementUUID);
+          const rect = await (driver as any).getElementRect(args.elementUUID);
           const x = Math.floor(rect.x + rect.width / 2);
           const y = Math.floor(rect.y + rect.height / 2);
 
-          await driver.performActions([
+          await (driver as any).performActions([
             {
               type: 'pointer',
               id: 'finger1',
@@ -56,16 +61,23 @@ export default function longPress(server: FastMCP): void {
           ]);
         } else if (platform === 'iOS') {
           try {
-            await driver.execute('mobile: touchAndHold', {
-              elementId: args.elementUUID,
-              duration: duration / 1000,
-            });
+            const _ok = isRemoteDriverSession(driver)
+              ? await (driver as Client).executeScript('mobile: touchAndHold', [
+                  {
+                    elementId: args.elementUUID,
+                    duration: duration / 1000,
+                  },
+                ])
+              : await (driver as any).execute('mobile: touchAndHold', {
+                  elementId: args.elementUUID,
+                  duration: duration / 1000,
+                });
           } catch (touchAndHoldError) {
-            const rect = await driver.getElementRect(args.elementUUID);
+            const rect = await (driver as any).getElementRect(args.elementUUID);
             const x = Math.floor(rect.x + rect.width / 2);
             const y = Math.floor(rect.y + rect.height / 2);
 
-            await driver.performActions([
+            await (driver as any).performActions([
               {
                 type: 'pointer',
                 id: 'finger1',

package/src/tools/interactions/screenshot.ts

@@ -1,12 +1,16 @@
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
-import { getDriver } from '../../session-store.js';
+import { FastMCP } from 'fastmcp';
+import { getDriver, isRemoteDriverSession } from '../../session-store.js';
 import { writeFile, mkdir } from 'fs/promises';
 import { join, isAbsolute } from 'path';
+import * as os from 'node:os';
 import {
   createUIResource,
   createScreenshotViewerUI,
   addUIResourceToResponse,
 } from '../../ui/mcp-ui-utils.js';
+import type { Client } from 'webdriver';
+import type { XCUITestDriver } from 'appium-xcuitest-driver';
+import type { AndroidUiautomator2Driver } from 'appium-uiautomator2-driver';
 
 /**
  * Resolves the screenshot directory path.
@@ -18,7 +22,7 @@ export function resolveScreenshotDir(): string {
   const screenshotDir = process.env.SCREENSHOTS_DIR;
 
   if (!screenshotDir) {
-    return process.cwd();
+    return os.tmpdir();
   }
 
   if (isAbsolute(screenshotDir)) {
@@ -29,7 +33,7 @@ export function resolveScreenshotDir(): string {
 }
 
 export interface ScreenshotDeps {
-  getDriver: () => { getScreenshot: () => Promise<string> } | null;
+  getDriver: () => Client | AndroidUiautomator2Driver | XCUITestDriver | null;
   writeFile: typeof writeFile;
   mkdir: typeof mkdir;
   resolveScreenshotDir: typeof resolveScreenshotDir;
@@ -53,7 +57,9 @@ export async function executeScreenshot(
   }
 
   try {
-    const screenshotBase64 = await driver.getScreenshot();
+    const screenshotBase64 = isRemoteDriverSession(driver)
+      ? await (driver as Client).takeScreenshot()
+      : await (driver as any).getScreenshot();
 
     // Convert base64 to buffer
     const screenshotBuffer = Buffer.from(screenshotBase64, 'base64');

package/src/tools/interactions/set-value.ts

@@ -1,7 +1,8 @@
-import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { FastMCP } from 'fastmcp';
 import { z } from 'zod';
-import { getDriver } from '../../session-store.js';
+import { getDriver, isRemoteDriverSession } from '../../session-store.js';
 import { elementUUIDScheme } from '../../schema.js';
+import type { Client } from 'webdriver';
 
 export default function setValue(server: FastMCP): void {
   const setValueSchema = z.object({
@@ -24,7 +25,12 @@ export default function setValue(server: FastMCP): void {
       }
 
       try {
-        await driver.setValue(args.text, args.elementUUID);
+        const _ok = isRemoteDriverSession(driver)
+          ? await (driver as Client).elementSendKeys(
+              args.elementUUID,
+              args.text
+            )
+          : await (driver as any).setValue(args.text, args.elementUUID);
         return {
           content: [
             {

package/src/tools/navigations/scroll-to-element.ts

@@ -84,7 +84,7 @@ async function performAndroidScroll(
     await driver.findElement('-android uiautomator', scrollCommand);
   } catch (error) {
     // If UiScrollable fails, try touch actions
-    const { width, height } = await driver.getWindowSize();
+    const { width, height } = await driver.getWindowRect();
     const startX = width / 2;
     const startY = direction === 'up' ? height * 0.3 : height * 0.7;
     const endY = direction === 'up' ? height * 0.7 : height * 0.3;
@@ -100,7 +100,7 @@ async function performAndroidScroll(
 
 async function performiOSScroll(driver: any, direction: string): Promise<void> {
   // Use iOS mobile commands for scrolling
-  const { width, height } = await driver.getWindowSize();
+  const { width, height } = await driver.getWindowRect();
 
   await driver.execute('mobile: scroll', {
     direction: direction,
@@ -133,7 +133,7 @@ export default function scrollToElement(server: any): void {
 
         // First try to find the element directly (it might already be in viewport)
         try {
-          const element = await driver.findElement(
+          const element = await (driver as any).findElement(
             args.strategy,
             args.selector
           );
@@ -160,7 +160,7 @@ export default function scrollToElement(server: any): void {
               );
           }
 
-          const element = await driver.findElement(
+          const element = await (driver as any).findElement(
             args.strategy,
             args.selector
           );

package/src/tools/navigations/scroll.ts

@@ -1,6 +1,11 @@
 import { z } from 'zod';
-import { getDriver, getPlatformName } from '../../session-store.js';
+import {
+  getDriver,
+  getPlatformName,
+  isRemoteDriverSession,
+} from '../../session-store.js';
 import log from '../../logger.js';
+import type { Client } from 'webdriver';
 
 export default function scroll(server: any): void {
   server.addTool({
@@ -25,7 +30,7 @@ export default function scroll(server: any): void {
       }
 
       try {
-        const { width, height } = await driver.getWindowSize();
+        const { width, height } = await (driver as any).getWindowRect();
         log.info('Device screen size:', { width, height });
         const startX = Math.floor(width / 2);
         // calculate start and end Y positions for scrolling depending on the direction
@@ -47,7 +52,7 @@ export default function scroll(server: any): void {
         log.info('Going to scroll to:', { startX, endY });
 
         if (getPlatformName(driver) === 'Android') {
-          await driver.performActions([
+          await (driver as any).performActions([
             {
               type: 'pointer',
               id: 'finger1',
@@ -63,13 +68,23 @@ export default function scroll(server: any): void {
           ]);
           log.info('Scroll action completed successfully.');
         } else if (getPlatformName(driver) === 'iOS') {
-          await driver.execute('mobile: scroll', {
-            direction: args.direction,
-            startX: startX,
-            startY: startY,
-            endX: startX,
-            endY: endY,
-          });
+          const _ok = isRemoteDriverSession(driver)
+            ? await (driver as Client).executeScript('mobile: scroll', [
+                {
+                  direction: args.direction,
+                  startX: startX,
+                  startY: startY,
+                  endX: startX,
+                  endY: endY,
+                },
+              ])
+            : await (driver as any).execute('mobile: scroll', {
+                direction: args.direction,
+                startX: startX,
+                startY: startY,
+                endX: startX,
+                endY: endY,
+              });
         } else {
           throw new Error(
             `Unsupported platform: ${getPlatformName(driver)}. Only Android and iOS are supported.`

package/src/tools/navigations/swipe.ts

@@ -1,7 +1,12 @@
 import { z } from 'zod';
-import { getDriver, getPlatformName } from '../../session-store.js';
+import {
+  getDriver,
+  getPlatformName,
+  isRemoteDriverSession,
+} from '../../session-store.js';
 import log from '../../logger.js';
 import { elementUUIDScheme } from '../../schema.js';
+import type { Client } from 'webdriver';
 
 function calculateSwipeCoordinates(
   direction: 'left' | 'right' | 'up' | 'down',
@@ -227,7 +232,7 @@ export default function swipe(server: any): void {
               endY,
             });
           } else {
-            const { width, height } = await driver.getWindowSize();
+            const { width, height } = await (driver as any).getWindowRect();
             log.info('Device screen size:', { width, height });
             const coords = calculateSwipeCoordinates(
               args.direction,
@@ -268,7 +273,7 @@ export default function swipe(server: any): void {
         if (platform === 'Android') {
           if (startX !== endX && Math.abs(startY - endY) < 50) {
             const swipeDuration = Math.min(duration, 400);
-            await driver.performActions([
+            await (driver as any).performActions([
               {
                 type: 'pointer',
                 id: 'finger1',
@@ -303,9 +308,15 @@ export default function swipe(server: any): void {
         } else if (platform === 'iOS') {
           if (args.direction) {
             try {
-              await driver.execute('mobile: swipe', {
-                direction: args.direction,
-              });
+              const _ok = isRemoteDriverSession(driver)
+                ? await (driver as Client).executeScript('mobile: swipe', [
+                    {
+                      direction: args.direction,
+                    },
+                  ])
+                : await (driver as any).execute('mobile: swipe', {
+                    direction: args.direction,
+                  });
               log.info(
                 `iOS swipe completed using mobile: swipe (${args.direction})`
               );