server.ts•18.4 kB
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { CallToolResult } from "@modelcontextprotocol/sdk/types";
import { z, ZodRawShape, ZodTypeAny } from "zod";
import fs from "node:fs";
import os from "node:os";
import crypto from "node:crypto";
import { execFileSync } from "node:child_process";
import { error, trace } from "./logger";
import { AndroidRobot, AndroidDeviceManager } from "./android";
import { ActionableError, Robot } from "./robot";
import { SimctlManager } from "./iphone-simulator";
import { IosManager, IosRobot } from "./ios";
import { PNG } from "./png";
import { isScalingAvailable, Image } from "./image-utils";
import { getMobilecliPath } from "./mobilecli";
export const getAgentVersion = (): string => {
const json = require("../package.json");
return json.version;
};
export const createMcpServer = (): McpServer => {
const server = new McpServer({
name: "mobile-mcp",
version: getAgentVersion(),
capabilities: {
resources: {},
tools: {},
},
});
// an empty object to satisfy windsurf
const noParams = z.object({});
const getClientName = (): string => {
try {
const clientInfo = server.server.getClientVersion();
const clientName = clientInfo?.name || "unknown";
return clientName;
} catch (error: any) {
return "unknown";
}
};
const tool = (name: string, description: string, paramsSchema: ZodRawShape, cb: (args: z.objectOutputType<ZodRawShape, ZodTypeAny>) => Promise<string>) => {
const wrappedCb = async (args: ZodRawShape): Promise<CallToolResult> => {
try {
trace(`Invoking ${name} with args: ${JSON.stringify(args)}`);
const response = await cb(args);
trace(`=> ${response}`);
posthog("tool_invoked", {}).then();
return {
content: [{ type: "text", text: response }],
};
} catch (error: any) {
if (error instanceof ActionableError) {
return {
content: [{ type: "text", text: `${error.message}. Please fix the issue and try again.` }],
};
} else {
// a real exception
trace(`Tool '${description}' failed: ${error.message} stack: ${error.stack}`);
return {
content: [{ type: "text", text: `Error: ${error.message}` }],
isError: true,
};
}
}
};
server.tool(name, description, paramsSchema, args => wrappedCb(args));
};
const posthog = async (event: string, properties: Record<string, string>) => {
try {
const url = "https://us.i.posthog.com/i/v0/e/";
const api_key = "phc_KHRTZmkDsU7A8EbydEK8s4lJpPoTDyyBhSlwer694cS";
const name = os.hostname() + process.execPath;
const distinct_id = crypto.createHash("sha256").update(name).digest("hex");
const systemProps: any = {
Platform: os.platform(),
Product: "mobile-mcp",
Version: getAgentVersion(),
NodeVersion: process.version,
};
const clientName = getClientName();
if (clientName !== "unknown") {
systemProps.AgentName = clientName;
}
await fetch(url, {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
api_key,
event,
properties: {
...systemProps,
...properties,
},
distinct_id,
})
});
} catch (err: any) {
// ignore
}
};
const getMobilecliVersion = (): string => {
try {
const path = getMobilecliPath();
const output = execFileSync(path, ["--version"], { encoding: "utf8" }).toString().trim();
if (output.startsWith("mobilecli version ")) {
return output.substring("mobilecli version ".length);
}
return "failed";
} catch (error: any) {
return "failed " + error.message;
}
};
const mobilecliVersion = getMobilecliVersion();
posthog("launch", { "MobilecliVersion": mobilecliVersion }).then();
const simulatorManager = new SimctlManager();
const getRobotFromDevice = (device: string): Robot => {
const iosManager = new IosManager();
const androidManager = new AndroidDeviceManager();
const simulators = simulatorManager.listBootedSimulators();
const androidDevices = androidManager.getConnectedDevices();
const iosDevices = iosManager.listDevices();
// Check if it's a simulator
const simulator = simulators.find(s => s.name === device);
if (simulator) {
return simulatorManager.getSimulator(device);
}
// Check if it's an Android device
const androidDevice = androidDevices.find(d => d.deviceId === device);
if (androidDevice) {
return new AndroidRobot(device);
}
// Check if it's an iOS device
const iosDevice = iosDevices.find(d => d.deviceId === device);
if (iosDevice) {
return new IosRobot(device);
}
throw new ActionableError(`Device "${device}" not found. Use the mobile_list_available_devices tool to see available devices.`);
};
tool(
"mobile_list_available_devices",
"List all available devices. This includes both physical devices and simulators. If there is more than one device returned, you need to let the user select one of them.",
{
noParams
},
async ({}) => {
const iosManager = new IosManager();
const androidManager = new AndroidDeviceManager();
const simulators = simulatorManager.listBootedSimulators();
const simulatorNames = simulators.map(d => d.name);
const androidDevices = androidManager.getConnectedDevices();
const iosDevices = await iosManager.listDevices();
const iosDeviceNames = iosDevices.map(d => d.deviceId);
const androidTvDevices = androidDevices.filter(d => d.deviceType === "tv").map(d => d.deviceId);
const androidMobileDevices = androidDevices.filter(d => d.deviceType === "mobile").map(d => d.deviceId);
const resp = ["Found these devices:"];
if (simulatorNames.length > 0) {
resp.push(`iOS simulators: [${simulatorNames.join(",")}]`);
}
if (iosDevices.length > 0) {
resp.push(`iOS devices: [${iosDeviceNames.join(",")}]`);
}
if (androidMobileDevices.length > 0) {
resp.push(`Android devices: [${androidMobileDevices.join(",")}]`);
}
if (androidTvDevices.length > 0) {
resp.push(`Android TV devices: [${androidTvDevices.join(",")}]`);
}
return resp.join("\n");
}
);
tool(
"mobile_list_apps",
"List all the installed apps on the device",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you.")
},
async ({ device }) => {
const robot = getRobotFromDevice(device);
const result = await robot.listApps();
return `Found these apps on device: ${result.map(app => `${app.appName} (${app.packageName})`).join(", ")}`;
}
);
tool(
"mobile_launch_app",
"Launch an app on mobile device. Use this to open a specific app. You can find the package name of the app by calling list_apps_on_device.",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
packageName: z.string().describe("The package name of the app to launch"),
},
async ({ device, packageName }) => {
const robot = getRobotFromDevice(device);
await robot.launchApp(packageName);
return `Launched app ${packageName}`;
}
);
tool(
"mobile_terminate_app",
"Stop and terminate an app on mobile device",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
packageName: z.string().describe("The package name of the app to terminate"),
},
async ({ device, packageName }) => {
const robot = getRobotFromDevice(device);
await robot.terminateApp(packageName);
return `Terminated app ${packageName}`;
}
);
tool(
"mobile_install_app",
"Install an app on mobile device",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
path: z.string().describe("The path to the app file to install. For iOS simulators, provide a .zip file or a .app directory. For Android provide an .apk file. For iOS real devices provide an .ipa file"),
},
async ({ device, path }) => {
const robot = getRobotFromDevice(device);
await robot.installApp(path);
return `Installed app from ${path}`;
}
);
tool(
"mobile_uninstall_app",
"Uninstall an app from mobile device",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
bundle_id: z.string().describe("Bundle identifier (iOS) or package name (Android) of the app to be uninstalled"),
},
async ({ device, bundle_id }) => {
const robot = getRobotFromDevice(device);
await robot.uninstallApp(bundle_id);
return `Uninstalled app ${bundle_id}`;
}
);
tool(
"mobile_get_screen_size",
"Get the screen size of the mobile device in pixels",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you.")
},
async ({ device }) => {
const robot = getRobotFromDevice(device);
const screenSize = await robot.getScreenSize();
return `Screen size is ${screenSize.width}x${screenSize.height} pixels`;
}
);
tool(
"mobile_click_on_screen_at_coordinates",
"Click on the screen at given x,y coordinates. If clicking on an element, use the list_elements_on_screen tool to find the coordinates.",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
x: z.number().describe("The x coordinate to click on the screen, in pixels"),
y: z.number().describe("The y coordinate to click on the screen, in pixels"),
},
async ({ device, x, y }) => {
const robot = getRobotFromDevice(device);
await robot.tap(x, y);
return `Clicked on screen at coordinates: ${x}, ${y}`;
}
);
tool(
"mobile_double_tap_on_screen",
"Double-tap on the screen at given x,y coordinates.",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
x: z.number().describe("The x coordinate to double-tap, in pixels"),
y: z.number().describe("The y coordinate to double-tap, in pixels"),
},
async ({ device, x, y }) => {
const robot = getRobotFromDevice(device);
await robot!.doubleTap(x, y);
return `Double-tapped on screen at coordinates: ${x}, ${y}`;
}
);
tool(
"mobile_long_press_on_screen_at_coordinates",
"Long press on the screen at given x,y coordinates. If long pressing on an element, use the list_elements_on_screen tool to find the coordinates.",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
x: z.number().describe("The x coordinate to long press on the screen, in pixels"),
y: z.number().describe("The y coordinate to long press on the screen, in pixels"),
},
async ({ device, x, y }) => {
const robot = getRobotFromDevice(device);
await robot.longPress(x, y);
return `Long pressed on screen at coordinates: ${x}, ${y}`;
}
);
tool(
"mobile_list_elements_on_screen",
"List elements on screen and their coordinates, with display text or accessibility label. Do not cache this result.",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you.")
},
async ({ device }) => {
const robot = getRobotFromDevice(device);
const elements = await robot.getElementsOnScreen();
const result = elements.map(element => {
const out: any = {
type: element.type,
text: element.text,
label: element.label,
name: element.name,
value: element.value,
identifier: element.identifier,
coordinates: {
x: element.rect.x,
y: element.rect.y,
width: element.rect.width,
height: element.rect.height,
},
};
if (element.focused) {
out.focused = true;
}
return out;
});
return `Found these elements on screen: ${JSON.stringify(result)}`;
}
);
tool(
"mobile_press_button",
"Press a button on device",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
button: z.string().describe("The button to press. Supported buttons: BACK (android only), HOME, VOLUME_UP, VOLUME_DOWN, ENTER, DPAD_CENTER (android tv only), DPAD_UP (android tv only), DPAD_DOWN (android tv only), DPAD_LEFT (android tv only), DPAD_RIGHT (android tv only)"),
},
async ({ device, button }) => {
const robot = getRobotFromDevice(device);
await robot.pressButton(button);
return `Pressed the button: ${button}`;
}
);
tool(
"mobile_open_url",
"Open a URL in browser on device",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
url: z.string().describe("The URL to open"),
},
async ({ device, url }) => {
const robot = getRobotFromDevice(device);
await robot.openUrl(url);
return `Opened URL: ${url}`;
}
);
tool(
"mobile_swipe_on_screen",
"Swipe on the screen",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
direction: z.enum(["up", "down", "left", "right"]).describe("The direction to swipe"),
x: z.number().optional().describe("The x coordinate to start the swipe from, in pixels. If not provided, uses center of screen"),
y: z.number().optional().describe("The y coordinate to start the swipe from, in pixels. If not provided, uses center of screen"),
distance: z.number().optional().describe("The distance to swipe in pixels. Defaults to 400 pixels for iOS or 30% of screen dimension for Android"),
},
async ({ device, direction, x, y, distance }) => {
const robot = getRobotFromDevice(device);
if (x !== undefined && y !== undefined) {
// Use coordinate-based swipe
await robot.swipeFromCoordinate(x, y, direction, distance);
const distanceText = distance ? ` ${distance} pixels` : "";
return `Swiped ${direction}${distanceText} from coordinates: ${x}, ${y}`;
} else {
// Use center-based swipe
await robot.swipe(direction);
return `Swiped ${direction} on screen`;
}
}
);
tool(
"mobile_type_keys",
"Type text into the focused element",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
text: z.string().describe("The text to type"),
submit: z.boolean().describe("Whether to submit the text. If true, the text will be submitted as if the user pressed the enter key."),
},
async ({ device, text, submit }) => {
const robot = getRobotFromDevice(device);
await robot.sendKeys(text);
if (submit) {
await robot.pressButton("ENTER");
}
return `Typed text: ${text}`;
}
);
tool(
"mobile_save_screenshot",
"Save a screenshot of the mobile device to a file",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
saveTo: z.string().describe("The path to save the screenshot to"),
},
async ({ device, saveTo }) => {
const robot = getRobotFromDevice(device);
const screenshot = await robot.getScreenshot();
fs.writeFileSync(saveTo, screenshot);
return `Screenshot saved to: ${saveTo}`;
}
);
server.tool(
"mobile_take_screenshot",
"Take a screenshot of the mobile device. Use this to understand what's on screen, if you need to press an element that is available through view hierarchy then you must list elements on screen instead. Do not cache this result.",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you.")
},
async ({ device }) => {
try {
const robot = getRobotFromDevice(device);
const screenSize = await robot.getScreenSize();
let screenshot = await robot.getScreenshot();
let mimeType = "image/png";
// validate we received a png, will throw exception otherwise
const image = new PNG(screenshot);
const pngSize = image.getDimensions();
if (pngSize.width <= 0 || pngSize.height <= 0) {
throw new ActionableError("Screenshot is invalid. Please try again.");
}
if (isScalingAvailable()) {
trace("Image scaling is available, resizing screenshot");
const image = Image.fromBuffer(screenshot);
const beforeSize = screenshot.length;
screenshot = image.resize(Math.floor(pngSize.width / screenSize.scale))
.jpeg({ quality: 75 })
.toBuffer();
const afterSize = screenshot.length;
trace(`Screenshot resized from ${beforeSize} bytes to ${afterSize} bytes`);
mimeType = "image/jpeg";
}
const screenshot64 = screenshot.toString("base64");
trace(`Screenshot taken: ${screenshot.length} bytes`);
return {
content: [{ type: "image", data: screenshot64, mimeType }]
};
} catch (err: any) {
error(`Error taking screenshot: ${err.message} ${err.stack}`);
return {
content: [{ type: "text", text: `Error: ${err.message}` }],
isError: true,
};
}
}
);
tool(
"mobile_set_orientation",
"Change the screen orientation of the device",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you."),
orientation: z.enum(["portrait", "landscape"]).describe("The desired orientation"),
},
async ({ device, orientation }) => {
const robot = getRobotFromDevice(device);
await robot.setOrientation(orientation);
return `Changed device orientation to ${orientation}`;
}
);
tool(
"mobile_get_orientation",
"Get the current screen orientation of the device",
{
device: z.string().describe("The device identifier to use. Use mobile_list_available_devices to find which devices are available to you.")
},
async ({ device }) => {
const robot = getRobotFromDevice(device);
const orientation = await robot.getOrientation();
return `Current device orientation is ${orientation}`;
}
);
return server;
};