Added tools for install,uninstall, terminateapp and listApps-android

Co-authored-by: SrinivasanTarget <[email protected]>

Author: saikrishna321

package.json

@@ -62,3 +62,4 @@
     "typescript": "^5.8.3"
   }
 }
+

src/server.ts

@@ -14,25 +14,25 @@ registerResources(server);
 registerTools(server);
 
 // Handle client connection and disconnection events
-server.on("connect", (event) => {
-  console.log("Client connected:", event.session);
+server.on('connect', event => {
+  console.log('Client connected:', event.session);
 });
 
-server.on("disconnect", async (event) => {
-  console.log("Client disconnected:", event.session);
+server.on('disconnect', async event => {
+  console.log('Client disconnected:', event.session);
   // Only try to clean up if there's an active session
   if (hasActiveSession()) {
     try {
-      console.log("Active session detected on disconnect, cleaning up...");
+      console.log('Active session detected on disconnect, cleaning up...');
       const deleted = await safeDeleteSession();
       if (deleted) {
-        console.log("Session cleaned up successfully on disconnect.");
+        console.log('Session cleaned up successfully on disconnect.');
       }
     } catch (error) {
-      console.error("Error cleaning up session on disconnect:", error);
+      console.error('Error cleaning up session on disconnect:', error);
     }
   } else {
-    console.log("No active session to clean up on disconnect.");
+    console.log('No active session to clean up on disconnect.');
   }
 });
 

src/tools/create-session.ts

@@ -5,7 +5,11 @@ import { z } from 'zod';
 import fs from 'fs';
 import { AndroidUiautomator2Driver } from 'appium-uiautomator2-driver';
 import { XCUITestDriver } from 'appium-xcuitest-driver';
-import { setSession, hasActiveSession, safeDeleteSession } from './sessionStore.js';
+import {
+  setSession,
+  hasActiveSession,
+  safeDeleteSession,
+} from './sessionStore.js';
 
 // Define capabilities type
 interface Capabilities {
@@ -45,7 +49,9 @@ export default function createSession(server: any): void {
       try {
         // Check if there's an existing session and clean it up first
         if (hasActiveSession()) {
-          console.log('Existing session detected, cleaning up before creating new session...');
+          console.log(
+            'Existing session detected, cleaning up before creating new session...'
+          );
           await safeDeleteSession();
         }
 

src/tools/delete-session.ts

@@ -17,7 +17,7 @@ export default function deleteSession(server: any): void {
     execute: async (): Promise<any> => {
       try {
         const deleted = await safeDeleteSession();
-        
+
         if (deleted) {
           return {
             content: [
@@ -43,4 +43,4 @@ export default function deleteSession(server: any): void {
       }
     },
   });
-}
+}

src/tools/index.ts

@@ -15,7 +15,10 @@ import setValue from './interactions/setValue.js';
 import getText from './interactions/getText.js';
 import screenshot from './interactions/screenshot.js';
 import activateApp from './interactions/activateApp.js';
+import installApp from './interactions/installApp.js';
+import uninstallApp from './interactions/uninstallApp.js';
 import terminateApp from './interactions/terminateApp.js';
+import listApps from './interactions/listApps.js';
 
 export default function registerTools(server: FastMCP): void {
   selectPlatform(server);
@@ -29,12 +32,15 @@ export default function registerTools(server: FastMCP): void {
   scrollToElement(server);
 
   activateApp(server);
+  installApp(server);
+  uninstallApp(server);
   terminateApp(server);
+  listApps(server);
   findElement(server);
   clickElement(server);
   setValue(server);
   getText(server);
-  screenshot(server);
+  //screenshot(server);
   generateTest(server);
   console.log('All tools registered');
 }

src/tools/interactions/installApp.ts

@@ -0,0 +1,45 @@
+import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { z } from 'zod';
+import { getDriver, getPlatformName } from '../sessionStore.js';
+
+export default function installApp(server: FastMCP): void {
+  const schema = z.object({
+    path: z.string().describe('Path to the app file to install'),
+  });
+
+  server.addTool({
+    name: 'appium_installApp',
+    description: 'Install an app on the device from a file path.',
+    parameters: schema,
+    execute: async (args: z.infer<typeof schema>) => {
+      const { path } = args;
+      const driver = await getDriver();
+      if (!driver) {
+        throw new Error('No driver found');
+      }
+      try {
+        const platform = getPlatformName(driver);
+        const params =
+          platform === 'Android' ? { appPath: path } : { app: path };
+        await (driver as any).execute('mobile: installApp', params);
+        return {
+          content: [
+            {
+              type: 'text',
+              text: 'App installed successfully',
+            },
+          ],
+        };
+      } catch (err: any) {
+        return {
+          content: [
+            {
+              type: 'text',
+              text: `Failed to install app. err: ${err.toString()}`,
+            },
+          ],
+        };
+      }
+    },
+  });
+}

src/tools/interactions/listApps.ts

@@ -0,0 +1,66 @@
+import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { z } from 'zod';
+import { getDriver, getPlatformName } from '../sessionStore.js';
+import { InstalledApp } from '../robot.js';
+
+async function listAppsFromDevice(): Promise<InstalledApp[]> {
+  const driver = await getDriver();
+  if (!driver) {
+    throw new Error('No driver found');
+  }
+
+  const platform = getPlatformName(driver);
+  if (platform === 'iOS') {
+    throw new Error('listApps is not yet implemented for iOS');
+  }
+
+  const appPackages = await driver.adb.adbExec([
+    'shell',
+    'cmd',
+    'package',
+    'list',
+    'packages',
+  ]);
+
+  const apps: InstalledApp[] = appPackages
+    .split('package:')
+    .filter((s: any) => s.trim())
+    .map((s: any) => ({
+      packageName: s.trim(),
+      appName: '',
+    }));
+
+  return apps;
+}
+
+export default function listApps(server: FastMCP): void {
+  const schema = z.object({});
+
+  server.addTool({
+    name: 'appium_list_apps',
+    description: 'List all installed apps on the device.',
+    parameters: schema,
+    execute: async () => {
+      try {
+        const apps = await listAppsFromDevice();
+        return {
+          content: [
+            {
+              type: 'text',
+              text: `Installed apps: ${JSON.stringify(apps, null, 2)}`,
+            },
+          ],
+        };
+      } catch (err: any) {
+        return {
+          content: [
+            {
+              type: 'text',
+              text: `Failed to list apps. err: ${err.toString()}`,
+            },
+          ],
+        };
+      }
+    },
+  });
+}

src/tools/interactions/terminateApp.ts

@@ -1,33 +1,34 @@
 import { FastMCP } from 'fastmcp/dist/FastMCP.js';
-import { getDriver } from '../sessionStore.js';
 import { z } from 'zod';
+import { getDriver, getPlatformName } from '../sessionStore.js';
 
 export default function terminateApp(server: FastMCP): void {
-  const terminateAppSchema = z.object({
-    id: z.string().describe('The app id'),
+  const schema = z.object({
+    id: z
+      .string()
+      .describe('App identifier (package name for Android, bundle ID for iOS)'),
   });
 
   server.addTool({
-    name: 'appium_terminate_app',
-    description: 'Terminate app by id',
-    parameters: terminateAppSchema,
-    annotations: {
-      readOnlyHint: false,
-      openWorldHint: false,
-    },
-    execute: async (args: { id: string }, context: any): Promise<any> => {
-      const driver = getDriver();
+    name: 'appium_terminateApp',
+    description: 'Terminate an app on the device.',
+    parameters: schema,
+    execute: async (args: z.infer<typeof schema>) => {
+      const { id } = args;
+      const driver = await getDriver();
       if (!driver) {
         throw new Error('No driver found');
       }
-
       try {
-        await driver.terminateApp(args.id);
+        const platform = getPlatformName(driver);
+        const params =
+          platform === 'Android' ? { appId: id } : { bundleId: id };
+        await (driver as any).execute('mobile: terminateApp', params);
         return {
           content: [
             {
               type: 'text',
-              text: `App ${args.id} terminated correctly.`,
+              text: 'App terminated successfully',
             },
           ],
         };
@@ -36,11 +37,11 @@ export default function terminateApp(server: FastMCP): void {
           content: [
             {
               type: 'text',
-              text: `Error terminating the app ${args.id}: ${err.toString()}`,
+              text: `Failed to terminate app. err: ${err.toString()}`,
             },
           ],
         };
       }
     },
   });
-}
+}

src/tools/interactions/uninstallApp.ts

@@ -0,0 +1,47 @@
+import { FastMCP } from 'fastmcp/dist/FastMCP.js';
+import { z } from 'zod';
+import { getDriver, getPlatformName } from '../sessionStore.js';
+
+export default function uninstallApp(server: FastMCP): void {
+  const schema = z.object({
+    id: z
+      .string()
+      .describe('App identifier (package name for Android, bundle ID for iOS)'),
+  });
+
+  server.addTool({
+    name: 'appium_uninstallApp',
+    description: 'Uninstall an app from the device.',
+    parameters: schema,
+    execute: async (args: z.infer<typeof schema>) => {
+      const { id } = args;
+      const driver = await getDriver();
+      if (!driver) {
+        throw new Error('No driver found');
+      }
+      try {
+        const platform = getPlatformName(driver);
+        const params =
+          platform === 'Android' ? { appId: id } : { bundleId: id };
+        await (driver as any).execute('mobile: removeApp', params);
+        return {
+          content: [
+            {
+              type: 'text',
+              text: 'App uninstalled successfully',
+            },
+          ],
+        };
+      } catch (err: any) {
+        return {
+          content: [
+            {
+              type: 'text',
+              text: `Failed to uninstall app. err: ${err.toString()}`,
+            },
+          ],
+        };
+      }
+    },
+  });
+}

src/tools/sessionStore.ts

@@ -49,11 +49,11 @@ export async function safeDeleteSession(): Promise<boolean> {
   try {
     console.log('Deleting current session');
     await driver.deleteSession();
-    
+
     // Clear the session from store
     driver = null;
     sessionId = null;
-    
+
     console.log('Session deleted successfully.');
     return true;
   } catch (error) {