Skip to main content

Model Context Protocol server for Quash - AI-powered mobile automation agent

Project description

Quash MCP - AI-Powered Mobile Automation

A Model Context Protocol (MCP) server for mobile automation testing with Quash. Control Android devices and run automated tests from any MCP-compatible host using natural language.

Features

  • ๐Ÿค– AI-Powered Automation: Control your Android device using plain English
  • ๐Ÿ“ฑ Device Connection: Works with emulators and physical devices
  • โš™๏ธ Flexible Configuration: Customize AI model, temperature, vision, reasoning, and more
  • ๐Ÿ”„ Real-Time Execution: Live progress streaming during task execution
  • ๐ŸŽฏ Suite Execution: Run multiple tasks in sequence with retry logic
  • ๐Ÿ“Š Usage Tracking: Monitor API costs and token usage
  • ๐Ÿ” Secure: API key authentication via Quash platform

Installation

pip install quash-mcp

All dependencies (including ADB tools and device connectivity) are automatically installed. AI execution happens on the Quash backend, keeping the client lightweight and proprietary logic protected.

Quick Start

1. Get Your API Key

  1. Visit quashbugs.com (or your deployment URL)
  2. Sign in with Google
  3. Go to Dashboard โ†’ API Keys
  4. Create a new API key

2. Add to Your MCP Host

Quash MCP works with any MCP-compatible host. Configure it to use python3 -m quash_mcp which works across all Python environments:

Manual Configuration (Recommended)

Add to your MCP host's config file:

Config file locations:

  • Claude Desktop (macOS): ~/Library/Application Support/Claude/claude_desktop_config.json
  • Claude Desktop (Linux): ~/.config/claude/claude_desktop_config.json
  • Claude Desktop (Windows): %APPDATA%\Claude\claude_desktop_config.json
  • Claude Code: ~/.claude.json (project-specific under projects.<path>.mcpServers)
{
  "mcpServers": {
    "quash": {
      "command": "python3",
      "args": ["-m", "quash_mcp"]
    }
  }
}

Why python3 -m quash_mcp?

  • Works in any Python environment (conda, venv, system)
  • No PATH configuration needed
  • Uses whichever Python has quash-mcp installed

Alternative: Direct Command (if in PATH)

If quash-mcp is in your PATH:

{
  "mcpServers": {
    "quash": {
      "command": "quash-mcp"
    }
  }
}

Then restart your MCP host.

3. Start Automating

Ask your AI assistant (via your MCP host):

"Setup Quash and connect to my Android device"
"Configure with my API key: mhg_xxxx..."
"Execute task: Open Settings and enable WiFi"

Available Tools

1. build

Setup and verify all dependencies.

Example:

Can you run the build tool to setup my system for Quash?

2. connect

Connect to an Android device or emulator.

Parameters:

  • device_serial (optional): Device serial number

Example:

Connect to my Android device

3. configure

Configure agent execution parameters.

Parameters:

  • quash_api_key: Your Quash API key from the web portal
  • model: LLM model (e.g., "anthropic/claude-sonnet-4", "openai/gpt-4o")
  • temperature: 0-2 (default: 0.2)
  • max_steps: Maximum execution steps (default: 15)
  • vision: Enable screenshots (default: false)
  • reasoning: Enable multi-step planning (default: false)
  • reflection: Enable self-improvement (default: false)
  • debug: Verbose logging (default: false)

Example:

Configure Quash with my API key mhg_xxx, use Claude Sonnet 4, and enable vision

4. execute

Run an automation task on the device.

Parameters:

  • task: Natural language task description

Example:

Execute task: Open Settings and navigate to WiFi settings

5. runsuite

Execute multiple tasks in sequence with retry logic.

Parameters:

  • suite_name: Name of the test suite
  • tasks: Array of tasks with retry and failure handling options

Example:

Run a test suite with these tasks: [
  {"prompt": "Open Settings", "type": "setup"},
  {"prompt": "Enable WiFi", "type": "test", "retries": 2},
  {"prompt": "Close Settings", "type": "teardown"}
]

6. usage

View API usage statistics and costs.

Example:

Show me my Quash usage statistics

Complete Workflow Example

User: "Setup Quash on my machine"
โ†’ Runs build tool
โ†’ Returns: All dependencies installed โœ“

User: "Connect to my Android emulator"
โ†’ Runs connect tool
โ†’ Returns: Connected to emulator-5554 โœ“

User: "Configure to use Claude Sonnet 4 with vision and my API key is mhg_xxx..."
โ†’ Runs configure tool
โ†’ Returns: Configuration set โœ“

User: "Execute task: Open Instagram and go to my profile"
โ†’ Runs execute tool with live streaming
โ†’ Returns: Task completed โœ“

User: "Show me my usage statistics"
โ†’ Runs usage tool
โ†’ Returns: Total cost: $0.15, 10 executions โœ“

Requirements

  • Python 3.11+ - Required for the MCP server
  • Android Device - Emulator or physical device with USB debugging enabled
  • Quash API Key - Get from quashbugs.com

Dependencies automatically installed:

  • Android Debug Bridge (ADB) - via adbutils
  • Quash Portal APK - via apkutils
  • MCP protocol support - via mcp
  • HTTP client - via httpx

Architecture

v0.2.0 uses a client-server architecture:

  • Client (quash-mcp): Lightweight MCP server handling device connections and API calls
  • Server (Quash backend): Proprietary AI execution engine (LLMs, agents, pricing logic)
quash-mcp/
โ”œโ”€โ”€ quash_mcp/
โ”‚   โ”œโ”€โ”€ __main__.py          # Module entry point for python -m
โ”‚   โ”œโ”€โ”€ server.py            # Main MCP server entry point
โ”‚   โ”œโ”€โ”€ backend_client.py    # API communication with Quash backend
โ”‚   โ”œโ”€โ”€ state.py             # Session state management
โ”‚   โ””โ”€โ”€ tools/
โ”‚       โ”œโ”€โ”€ build.py         # Dependency checker and installer
โ”‚       โ”œโ”€โ”€ connect.py       # Device connectivity
โ”‚       โ”œโ”€โ”€ configure.py     # Agent configuration
โ”‚       โ”œโ”€โ”€ execute.py       # Task execution (calls backend API)
โ”‚       โ”œโ”€โ”€ runsuite.py      # Suite execution (calls backend API)
โ”‚       โ””โ”€โ”€ usage.py         # Usage statistics (from backend)
โ””โ”€โ”€ pyproject.toml

Troubleshooting

"No devices found"

  • Start Android emulator via Android Studio > AVD Manager
  • Connect physical device with USB debugging enabled
  • For WiFi debugging: adb tcpip 5555 && adb connect <device-ip>:5555

"Portal not ready"

  • The connect tool automatically installs the Portal APK
  • If it fails, manually enable the Quash Portal accessibility service in Settings > Accessibility

"Invalid API key"

  • Make sure you've run configure with a valid API key from quashbugs.com
  • API keys start with mhg_ prefix
  • Check your API key hasn't been revoked in the web portal

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quash_mcp-0.2.1.tar.gz (27.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quash_mcp-0.2.1-py3-none-any.whl (32.8 kB view details)

Uploaded Python 3

File details

Details for the file quash_mcp-0.2.1.tar.gz.

File metadata

  • Download URL: quash_mcp-0.2.1.tar.gz
  • Upload date:
  • Size: 27.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for quash_mcp-0.2.1.tar.gz
Algorithm Hash digest
SHA256 cf8e584017bee2ba87fb175ad510275ca538e58dc3218dcd034024c2f69c6e5f
MD5 915cfb6dc514af9ec76cad8b5176cbb5
BLAKE2b-256 f3b6afb329fc5be2d300c1553f709a5060314312f84330953a1b90fd154f8236

See more details on using hashes here.

File details

Details for the file quash_mcp-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: quash_mcp-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 32.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for quash_mcp-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 628f91e482271e18b3fea61e322e73856f0e6b4cf5614a62588fade4859df9ef
MD5 b5870ce90370cc1f8bfa6255662473b3
BLAKE2b-256 21690c92bc25ae0947372c5564f5466c65e23ed3437d55a37a2e4169f6f3cecd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page