appium-mcp 1.8.11 → 1.8.13

package/src/tools/app-management/uninstall-app.ts

@@ -1,56 +0,0 @@
-import { FastMCP } from 'fastmcp';
-import { z } from 'zod';
-import {
-  getDriver,
-  getPlatformName,
-  isRemoteDriverSession,
-} from '../../session-store.js';
-import type { Client } from 'webdriver';
-
-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_uninstall_app',
-    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 };
-        const _ok = isRemoteDriverSession(driver)
-          ? await (driver as Client).executeScript('mobile: removeApp', [
-              params,
-            ])
-          : 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()}`,
-            },
-          ],
-        };
-      }
-    },
-  });
-}

package/src/tools/context/get-contexts.ts

@@ -1,78 +0,0 @@
-import { FastMCP } from 'fastmcp';
-import { z } from 'zod';
-import { getDriver, isRemoteDriverSession } from '../../session-store.js';
-import {
-  createUIResource,
-  createContextSwitcherUI,
-  addUIResourceToResponse,
-} from '../../ui/mcp-ui-utils.js';
-
-export default function getContexts(server: FastMCP): void {
-  server.addTool({
-    name: 'appium_get_contexts',
-    description:
-      'Get all available contexts in the current Appium session. Returns a list of context names including NATIVE_APP and any webview contexts (e.g., WEBVIEW_<id> or WEBVIEW_<package>).',
-    parameters: z.object({}),
-    annotations: {
-      readOnlyHint: true,
-      openWorldHint: false,
-    },
-    execute: async (args: any, context: any): Promise<any> => {
-      const driver = getDriver();
-      if (!driver) {
-        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, contexts] = await Promise.all([
-          (driver as any).getCurrentContext().catch(() => null),
-          (driver as any).getContexts().catch(() => []),
-        ]);
-
-        if (!contexts || contexts.length === 0) {
-          return {
-            content: [
-              {
-                type: 'text',
-                text: 'No contexts available.',
-              },
-            ],
-          };
-        }
-
-        const textResponse = {
-          content: [
-            {
-              type: 'text',
-              text: `Available contexts: ${JSON.stringify(contexts, null, 2)}\nCurrent context: ${currentContext || 'N/A'}`,
-            },
-          ],
-        };
-
-        // Add interactive context switcher UI
-        const uiResource = createUIResource(
-          `ui://appium-mcp/context-switcher/${Date.now()}`,
-          createContextSwitcherUI(contexts, currentContext)
-        );
-
-        return addUIResourceToResponse(textResponse, uiResource);
-      } catch (err: any) {
-        return {
-          content: [
-            {
-              type: 'text',
-              text: `Failed to get contexts. Error: ${err.toString()}`,
-            },
-          ],
-          isError: true,
-        };
-      }
-    },
-  });
-}

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

@@ -1,106 +0,0 @@
-import { FastMCP } from 'fastmcp';
-import { z } from 'zod';
-import {
-  getDriver,
-  getPlatformName,
-  isRemoteDriverSession,
-  PLATFORM,
-} from '../../session-store.js';
-
-export default function switchContext(server: FastMCP): void {
-  const schema = z.object({
-    context: z
-      .string()
-      .describe(
-        'The name of the context to switch to. Common values: "NATIVE_APP" for native context, or "WEBVIEW_<id>" / "WEBVIEW_<package>" for webview contexts.'
-      ),
-  });
-
-  server.addTool({
-    name: 'appium_switch_context',
-    description:
-      'Switch to a specific context in the Appium session. Use this to switch between native app context (NATIVE_APP) and webview contexts (WEBVIEW_<id> or WEBVIEW_<package>). Use appium_get_contexts to see available contexts first.',
-    parameters: schema,
-    annotations: {
-      readOnlyHint: false,
-      openWorldHint: false,
-    },
-    execute: async (args: any, context: any): Promise<any> => {
-      const driver = getDriver();
-      if (!driver) {
-        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 as any).getCurrentContext().catch(() => null),
-          (driver as any).getContexts().catch(() => []),
-        ]);
-
-        if (currentContext === args.context) {
-          return {
-            content: [
-              {
-                type: 'text',
-                text: `Already on context "${args.context}".`,
-              },
-            ],
-          };
-        }
-
-        if (!availableContexts || availableContexts.length === 0) {
-          return {
-            content: [
-              {
-                type: 'text',
-                text: 'No contexts available. Cannot switch context.',
-              },
-            ],
-            isError: true,
-          };
-        }
-
-        if (!availableContexts.includes(args.context)) {
-          return {
-            content: [
-              {
-                type: 'text',
-                text: `Context "${args.context}" not found. Available contexts: ${JSON.stringify(availableContexts, null, 2)}`,
-              },
-            ],
-            isError: true,
-          };
-        }
-        await (driver as any).switchContext(args.context);
-
-        // Verify the switch was successful
-        const newContext = await (driver as any).getCurrentContext();
-
-        return {
-          content: [
-            {
-              type: 'text',
-              text: `Successfully switched context from "${currentContext || 'N/A'}" to "${newContext}".`,
-            },
-          ],
-        };
-      } catch (err: any) {
-        return {
-          content: [
-            {
-              type: 'text',
-              text: `Failed to switch context. Error: ${err.toString()}`,
-            },
-          ],
-          isError: true,
-        };
-      }
-    },
-  });
-}

package/src/tools/documentation/answer-appium.ts

@@ -1,73 +0,0 @@
-/**
- * Tool to select mobile platform before creating a session
- */
-import { z } from 'zod';
-import { answerAppiumQuery, initializeAppiumDocumentation } from './index.js';
-import log from '../../logger.js';
-
-export default function answerAppium(server: any): void {
-  server.addTool({
-    name: 'appium_documentation_query',
-    description: `Query Appium documentation using RAG (Retrieval-Augmented Generation).
-      This tool searches through indexed Appium documentation to answer questions about Appium features, setup, configuration, drivers, and usage.
-      `,
-    parameters: z.object({
-      query: z
-        .string()
-        .describe('The question or query about Appium documentation'),
-    }),
-    execute: async (args: any, context: any): Promise<any> => {
-      const query = args.query;
-      if (!query) {
-        return {
-          content: [
-            {
-              type: 'text',
-              text: 'Query parameter is required',
-            },
-          ],
-          isError: true,
-        };
-      }
-
-      try {
-        const result = await answerAppiumQuery({ query });
-        return {
-          content: [
-            {
-              type: 'text',
-              text: result.answer,
-            },
-          ],
-        };
-      } catch (docError) {
-        // If documentation query fails, try to initialize and retry once
-        try {
-          log.info('Documentation not initialized, initializing now...');
-          await initializeAppiumDocumentation();
-          const result = await answerAppiumQuery({ query });
-          return {
-            content: [
-              {
-                type: 'text',
-                text: result.answer,
-              },
-            ],
-          };
-        } catch (retryError) {
-          return {
-            content: [
-              {
-                type: 'text',
-                text: `Error querying Appium documentation: ${
-                  (retryError as Error).message
-                }. Please ensure the documentation is indexed first.`,
-              },
-            ],
-            isError: true,
-          };
-        }
-      }
-    },
-  });
-}

package/src/tools/documentation/index.ts

@@ -1,98 +0,0 @@
-/**
- * Documentation tools for Appium
- *
- * This module provides tools for answering queries about Appium
- * by retrieving relevant information from indexed documentation.
- */
-
-import {
-  queryVectorStore,
-  indexAllMarkdownFiles,
-} from './simple-pdf-indexer.js';
-import * as path from 'path';
-import log from '../../logger.js';
-
-/**
- * Interface for the query response
- */
-interface QueryResponse {
-  answer: string;
-  sources?: string[];
-  chunks?: string[];
-}
-
-/**
- * Initialize the Appium documentation index
- * @param resourcesPath Path to the resources directory containing markdown files
- */
-export async function initializeAppiumDocumentation(
-  resourcesPath?: string
-): Promise<void> {
-  try {
-    // Default to submodules directory if not specified
-    const docsPath =
-      resourcesPath || path.resolve(__dirname, '../../resources/submodules');
-    log.info(`Initializing Appium documentation from: ${docsPath}`);
-    await indexAllMarkdownFiles(docsPath);
-    log.info('Appium documentation indexing completed');
-  } catch (error) {
-    log.error('Error initializing Appium documentation:', error);
-    throw error;
-  }
-}
-
-/**
- * Answer a query about Appium using indexed documentation
- * @param options Query options
- * @returns Response with relevant chunks for the client LLM to process
- */
-export async function answerAppiumQuery(options: {
-  query: string;
-}): Promise<QueryResponse> {
-  try {
-    const { query } = options;
-    log.info(`Querying vector store for: "${query}"`);
-    const results = await queryVectorStore(query); // Get relevant chunks
-
-    if (!results || results.length === 0) {
-      return {
-        answer:
-          'No relevant information found in the Appium documentation. Please try rephrasing your query.',
-        chunks: [],
-      };
-    }
-
-    // Extract the content from all retrieved documents
-    const chunks = results.map((doc: any) => doc.pageContent);
-    const sources = results
-      .map(
-        (doc: any) =>
-          doc.metadata?.relativePath ||
-          doc.metadata?.filename ||
-          doc.metadata?.source
-      )
-      .filter(
-        (source: any, index: number, arr: any[]) =>
-          source && arr.indexOf(source) === index
-      ); // Remove duplicates
-
-    log.info(
-      `Found ${results.length} relevant chunks from ${sources.length} sources`
-    );
-
-    // Return the chunks for the client LLM to process
-    // The client will use its own LLM to generate the final answer
-    return {
-      answer: `Found ${
-        results.length
-      } relevant documentation chunks. Here are the relevant sections:\n\n${chunks.join(
-        '\n\n---\n\n'
-      )}`,
-      sources,
-      chunks,
-    };
-  } catch (error) {
-    log.error('Error querying Appium documentation:', error);
-    throw error;
-  }
-}