appium-mcp 0.1.0__tar.gz

appium_mcp-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Pavan Kumar S
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

appium_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: appium-mcp
+Version: 0.1.0
+Summary: AI-driven mobile automation with Appium MCP server and AWS Bedrock integration
+Author-email: You Can Automate <youcanautomate@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/youcanautomate-yca/appium-mcp
+Project-URL: Documentation, https://github.com/youcanautomate-yca/appium-mcp#readme
+Project-URL: Repository, https://github.com/youcanautomate-yca/appium-mcp.git
+Project-URL: Issues, https://github.com/youcanautomate-yca/appium-mcp/issues
+Keywords: appium,mobile-automation,mcp,model-context-protocol,ai,bedrock,testing,ios,android
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: pydantic>=2.11.0
+Requires-Dist: appium-python-client==3.1.0
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: python-dotenv==1.0.0
+Requires-Dist: boto3>=1.26.0
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+# Appium MCP Python Implementation
+
+This is a Python implementation of the Appium MCP (Model Context Protocol) server that mirrors all tools from the TypeScript [appium-mcp](../appium-mcp) server.
+
+## Overview
+
+This project provides a Python-based MCP server for Appium mobile automation with AI integration. It supports both iOS and Android automation with comprehensive tool coverage.
+
+## Features
+
+- **Session Management**: Create and manage Appium sessions
+- **Element Interactions**: Click, tap, long press, drag, text input, and more
+- **Navigation**: Scroll, swipe, and navigate through UI
+- **App Management**: Install, uninstall, activate, terminate apps
+- **Context Switching**: Switch between native and web contexts
+- **iOS Support**: Simulator management and WebDriverAgent setup
+- **Screenshot Capture**: Full page and element-specific screenshots
+- **Test Generation**: Auto-generate test scripts from actions
+- **Locator Generation**: Parse page source and generate element locators
+
+## Installation
+
+### Requirements
+- Python 3.8+
+- pip
+
+### Setup
+
+1. Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+2. Ensure Appium server is running:
+
+```bash
+appium --address localhost --port 4723
+```
+
+## Architecture
+
+The server is organized into modular components:
+
+```
+ai-driven-mobile-automation/
+├── server.py              # Main MCP server and tool registration
+├── session_store.py       # Global driver and session management
+├── command.py             # Core Appium command execution
+├── logger.py              # Logging utilities
+├── tools_session.py       # Session management tools
+├── tools_interactions.py  # Element interaction tools
+├── tools_navigations.py   # Navigation tools
+├── tools_app_management.py # App management tools
+├── tools_context.py       # Context switching tools
+├── tools_ios.py           # iOS-specific tools
+├── tools_test_generation.py # Test generation tools
+├── tools_documentation.py  # Documentation/help tools
+├── requirements.txt       # Python dependencies
+└── README.md             # This file
+```
+
+## Mirrored Tools from TypeScript Implementation
+
+### Session Management
+- `select_platform` - Select iOS or Android platform
+- `select_device` - Select target device
+- `create_session` - Create new Appium session
+- `delete_session` - Delete active session
+- `open_notifications` - Open notifications panel
+
+### Element Interactions
+- `appium_click` - Click on element
+- `appium_find_element` - Find element by strategy/selector
+- `appium_double_tap` - Double tap element
+- `appium_long_press` - Long press element
+- `appium_drag_and_drop` - Drag element to target
+- `appium_press_key` - Press key
+- `appium_set_value` - Set text value
+- `appium_get_text` - Get element text
+- `appium_get_active_element` - Get focused element
+- `appium_screenshot` - Take screenshot
+- `appium_element_screenshot` - Screenshot of element
+- `appium_get_orientation` - Get device orientation
+- `appium_set_orientation` - Set device orientation
+- `appium_handle_alert` - Handle alert dialogs
+
+### Navigation
+- `appium_scroll` - Scroll up/down/left/right
+- `appium_scroll_to_element` - Scroll until element visible
+- `appium_swipe` - Perform swipe gesture
+
+### App Management
+- `appium_activate_app` - Activate installed app
+- `appium_install_app` - Install app
+- `appium_uninstall_app` - Uninstall app
+- `appium_terminate_app` - Terminate running app
+- `appium_list_apps` - List installed apps
+- `appium_is_app_installed` - Check if app installed
+- `appium_deep_link` - Open deep link
+
+### Context Management
+- `appium_get_contexts` - Get available contexts
+- `appium_switch_context` - Switch between contexts
+
+### iOS Tools
+- `appium_boot_simulator` - Boot iOS simulator
+- `appium_setup_wda` - Setup WebDriverAgent
+- `appium_install_wda` - Install WebDriverAgent
+
+### Test Generation
+- `appium_generate_locators` - Generate element locators
+- `appium_generate_tests` - Generate test scripts
+
+### Documentation
+- `appium_answer_appium` - Answer Appium questions
+
+## Running the Server
+
+```bash
+python server.py
+```
+
+The server will start listening on stdin/stdout for MCP protocol messages.
+
+## Usage Example
+
+```python
+import asyncio
+from mcp.client import StdioClient
+
+async def main():
+    # Create client
+    client = StdioClient("python", ["server.py"])
+    
+    # Call a tool
+    result = await client.call_tool(
+        "select_platform",
+        {"platform": "ios"}
+    )
+    print(result)
+
+asyncio.run(main())
+```
+
+## Tool Schemas
+
+Each tool includes:
+- `name`: Unique tool identifier
+- `description`: Human-readable description
+- `inputSchema`: JSON schema for parameters
+- `execute`: Async function that implements the tool
+
+## Error Handling
+
+All tools return a status JSON response:
+
+```json
+{
+    "status": "success|error|warning",
+    "message": "Human-readable message",
+    ...tool-specific fields
+}
+```
+
+## Logging
+
+Logs are written to stderr with format:
+```
+[TOOL START] tool_name: arguments
+[TOOL END] tool_name
+[TOOL ERROR] tool_name: error message
+```
+
+## Differences from TypeScript Implementation
+
+1. **Async/Await**: Python version uses async/await instead of Promise-based TypeScript
+2. **Module Organization**: Simplified into single Python files instead of separate TypeScript modules
+3. **Error Handling**: Try-catch blocks instead of TypeScript error handling
+4. **Type System**: Uses type hints instead of TypeScript types
+
+## Contributing
+
+To add new tools:
+
+1. Create a function in the appropriate `tools_*.py` file
+2. Register it in `server.py` in the `register_tools()` function
+3. Document the tool parameters and return values
+
+## License
+
+Same as parent appium-mcp project.
+
+## Related
+
+- [TypeScript Implementation](../appium-mcp/README.md)
+- [Appium Documentation](https://appium.io)
+- [MCP Specification](https://modelcontextprotocol.io)

appium_mcp-0.1.0/README.md

@@ -0,0 +1,198 @@
+# Appium MCP Python Implementation
+
+This is a Python implementation of the Appium MCP (Model Context Protocol) server that mirrors all tools from the TypeScript [appium-mcp](../appium-mcp) server.
+
+## Overview
+
+This project provides a Python-based MCP server for Appium mobile automation with AI integration. It supports both iOS and Android automation with comprehensive tool coverage.
+
+## Features
+
+- **Session Management**: Create and manage Appium sessions
+- **Element Interactions**: Click, tap, long press, drag, text input, and more
+- **Navigation**: Scroll, swipe, and navigate through UI
+- **App Management**: Install, uninstall, activate, terminate apps
+- **Context Switching**: Switch between native and web contexts
+- **iOS Support**: Simulator management and WebDriverAgent setup
+- **Screenshot Capture**: Full page and element-specific screenshots
+- **Test Generation**: Auto-generate test scripts from actions
+- **Locator Generation**: Parse page source and generate element locators
+
+## Installation
+
+### Requirements
+- Python 3.8+
+- pip
+
+### Setup
+
+1. Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+2. Ensure Appium server is running:
+
+```bash
+appium --address localhost --port 4723
+```
+
+## Architecture
+
+The server is organized into modular components:
+
+```
+ai-driven-mobile-automation/
+├── server.py              # Main MCP server and tool registration
+├── session_store.py       # Global driver and session management
+├── command.py             # Core Appium command execution
+├── logger.py              # Logging utilities
+├── tools_session.py       # Session management tools
+├── tools_interactions.py  # Element interaction tools
+├── tools_navigations.py   # Navigation tools
+├── tools_app_management.py # App management tools
+├── tools_context.py       # Context switching tools
+├── tools_ios.py           # iOS-specific tools
+├── tools_test_generation.py # Test generation tools
+├── tools_documentation.py  # Documentation/help tools
+├── requirements.txt       # Python dependencies
+└── README.md             # This file
+```
+
+## Mirrored Tools from TypeScript Implementation
+
+### Session Management
+- `select_platform` - Select iOS or Android platform
+- `select_device` - Select target device
+- `create_session` - Create new Appium session
+- `delete_session` - Delete active session
+- `open_notifications` - Open notifications panel
+
+### Element Interactions
+- `appium_click` - Click on element
+- `appium_find_element` - Find element by strategy/selector
+- `appium_double_tap` - Double tap element
+- `appium_long_press` - Long press element
+- `appium_drag_and_drop` - Drag element to target
+- `appium_press_key` - Press key
+- `appium_set_value` - Set text value
+- `appium_get_text` - Get element text
+- `appium_get_active_element` - Get focused element
+- `appium_screenshot` - Take screenshot
+- `appium_element_screenshot` - Screenshot of element
+- `appium_get_orientation` - Get device orientation
+- `appium_set_orientation` - Set device orientation
+- `appium_handle_alert` - Handle alert dialogs
+
+### Navigation
+- `appium_scroll` - Scroll up/down/left/right
+- `appium_scroll_to_element` - Scroll until element visible
+- `appium_swipe` - Perform swipe gesture
+
+### App Management
+- `appium_activate_app` - Activate installed app
+- `appium_install_app` - Install app
+- `appium_uninstall_app` - Uninstall app
+- `appium_terminate_app` - Terminate running app
+- `appium_list_apps` - List installed apps
+- `appium_is_app_installed` - Check if app installed
+- `appium_deep_link` - Open deep link
+
+### Context Management
+- `appium_get_contexts` - Get available contexts
+- `appium_switch_context` - Switch between contexts
+
+### iOS Tools
+- `appium_boot_simulator` - Boot iOS simulator
+- `appium_setup_wda` - Setup WebDriverAgent
+- `appium_install_wda` - Install WebDriverAgent
+
+### Test Generation
+- `appium_generate_locators` - Generate element locators
+- `appium_generate_tests` - Generate test scripts
+
+### Documentation
+- `appium_answer_appium` - Answer Appium questions
+
+## Running the Server
+
+```bash
+python server.py
+```
+
+The server will start listening on stdin/stdout for MCP protocol messages.
+
+## Usage Example
+
+```python
+import asyncio
+from mcp.client import StdioClient
+
+async def main():
+    # Create client
+    client = StdioClient("python", ["server.py"])
+    
+    # Call a tool
+    result = await client.call_tool(
+        "select_platform",
+        {"platform": "ios"}
+    )
+    print(result)
+
+asyncio.run(main())
+```
+
+## Tool Schemas
+
+Each tool includes:
+- `name`: Unique tool identifier
+- `description`: Human-readable description
+- `inputSchema`: JSON schema for parameters
+- `execute`: Async function that implements the tool
+
+## Error Handling
+
+All tools return a status JSON response:
+
+```json
+{
+    "status": "success|error|warning",
+    "message": "Human-readable message",
+    ...tool-specific fields
+}
+```
+
+## Logging
+
+Logs are written to stderr with format:
+```
+[TOOL START] tool_name: arguments
+[TOOL END] tool_name
+[TOOL ERROR] tool_name: error message
+```
+
+## Differences from TypeScript Implementation
+
+1. **Async/Await**: Python version uses async/await instead of Promise-based TypeScript
+2. **Module Organization**: Simplified into single Python files instead of separate TypeScript modules
+3. **Error Handling**: Try-catch blocks instead of TypeScript error handling
+4. **Type System**: Uses type hints instead of TypeScript types
+
+## Contributing
+
+To add new tools:
+
+1. Create a function in the appropriate `tools_*.py` file
+2. Register it in `server.py` in the `register_tools()` function
+3. Document the tool parameters and return values
+
+## License
+
+Same as parent appium-mcp project.
+
+## Related
+
+- [TypeScript Implementation](../appium-mcp/README.md)
+- [Appium Documentation](https://appium.io)
+- [MCP Specification](https://modelcontextprotocol.io)

appium_mcp-0.1.0/appium_mcp.egg-info/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: appium-mcp
+Version: 0.1.0
+Summary: AI-driven mobile automation with Appium MCP server and AWS Bedrock integration
+Author-email: You Can Automate <youcanautomate@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/youcanautomate-yca/appium-mcp
+Project-URL: Documentation, https://github.com/youcanautomate-yca/appium-mcp#readme
+Project-URL: Repository, https://github.com/youcanautomate-yca/appium-mcp.git
+Project-URL: Issues, https://github.com/youcanautomate-yca/appium-mcp/issues
+Keywords: appium,mobile-automation,mcp,model-context-protocol,ai,bedrock,testing,ios,android
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: pydantic>=2.11.0
+Requires-Dist: appium-python-client==3.1.0
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: python-dotenv==1.0.0
+Requires-Dist: boto3>=1.26.0
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+# Appium MCP Python Implementation
+
+This is a Python implementation of the Appium MCP (Model Context Protocol) server that mirrors all tools from the TypeScript [appium-mcp](../appium-mcp) server.
+
+## Overview
+
+This project provides a Python-based MCP server for Appium mobile automation with AI integration. It supports both iOS and Android automation with comprehensive tool coverage.
+
+## Features
+
+- **Session Management**: Create and manage Appium sessions
+- **Element Interactions**: Click, tap, long press, drag, text input, and more
+- **Navigation**: Scroll, swipe, and navigate through UI
+- **App Management**: Install, uninstall, activate, terminate apps
+- **Context Switching**: Switch between native and web contexts
+- **iOS Support**: Simulator management and WebDriverAgent setup
+- **Screenshot Capture**: Full page and element-specific screenshots
+- **Test Generation**: Auto-generate test scripts from actions
+- **Locator Generation**: Parse page source and generate element locators
+
+## Installation
+
+### Requirements
+- Python 3.8+
+- pip
+
+### Setup
+
+1. Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+2. Ensure Appium server is running:
+
+```bash
+appium --address localhost --port 4723
+```
+
+## Architecture
+
+The server is organized into modular components:
+
+```
+ai-driven-mobile-automation/
+├── server.py              # Main MCP server and tool registration
+├── session_store.py       # Global driver and session management
+├── command.py             # Core Appium command execution
+├── logger.py              # Logging utilities
+├── tools_session.py       # Session management tools
+├── tools_interactions.py  # Element interaction tools
+├── tools_navigations.py   # Navigation tools
+├── tools_app_management.py # App management tools
+├── tools_context.py       # Context switching tools
+├── tools_ios.py           # iOS-specific tools
+├── tools_test_generation.py # Test generation tools
+├── tools_documentation.py  # Documentation/help tools
+├── requirements.txt       # Python dependencies
+└── README.md             # This file
+```
+
+## Mirrored Tools from TypeScript Implementation
+
+### Session Management
+- `select_platform` - Select iOS or Android platform
+- `select_device` - Select target device
+- `create_session` - Create new Appium session
+- `delete_session` - Delete active session
+- `open_notifications` - Open notifications panel
+
+### Element Interactions
+- `appium_click` - Click on element
+- `appium_find_element` - Find element by strategy/selector
+- `appium_double_tap` - Double tap element
+- `appium_long_press` - Long press element
+- `appium_drag_and_drop` - Drag element to target
+- `appium_press_key` - Press key
+- `appium_set_value` - Set text value
+- `appium_get_text` - Get element text
+- `appium_get_active_element` - Get focused element
+- `appium_screenshot` - Take screenshot
+- `appium_element_screenshot` - Screenshot of element
+- `appium_get_orientation` - Get device orientation
+- `appium_set_orientation` - Set device orientation
+- `appium_handle_alert` - Handle alert dialogs
+
+### Navigation
+- `appium_scroll` - Scroll up/down/left/right
+- `appium_scroll_to_element` - Scroll until element visible
+- `appium_swipe` - Perform swipe gesture
+
+### App Management
+- `appium_activate_app` - Activate installed app
+- `appium_install_app` - Install app
+- `appium_uninstall_app` - Uninstall app
+- `appium_terminate_app` - Terminate running app
+- `appium_list_apps` - List installed apps
+- `appium_is_app_installed` - Check if app installed
+- `appium_deep_link` - Open deep link
+
+### Context Management
+- `appium_get_contexts` - Get available contexts
+- `appium_switch_context` - Switch between contexts
+
+### iOS Tools
+- `appium_boot_simulator` - Boot iOS simulator
+- `appium_setup_wda` - Setup WebDriverAgent
+- `appium_install_wda` - Install WebDriverAgent
+
+### Test Generation
+- `appium_generate_locators` - Generate element locators
+- `appium_generate_tests` - Generate test scripts
+
+### Documentation
+- `appium_answer_appium` - Answer Appium questions
+
+## Running the Server
+
+```bash
+python server.py
+```
+
+The server will start listening on stdin/stdout for MCP protocol messages.
+
+## Usage Example
+
+```python
+import asyncio
+from mcp.client import StdioClient
+
+async def main():
+    # Create client
+    client = StdioClient("python", ["server.py"])
+    
+    # Call a tool
+    result = await client.call_tool(
+        "select_platform",
+        {"platform": "ios"}
+    )
+    print(result)
+
+asyncio.run(main())
+```
+
+## Tool Schemas
+
+Each tool includes:
+- `name`: Unique tool identifier
+- `description`: Human-readable description
+- `inputSchema`: JSON schema for parameters
+- `execute`: Async function that implements the tool
+
+## Error Handling
+
+All tools return a status JSON response:
+
+```json
+{
+    "status": "success|error|warning",
+    "message": "Human-readable message",
+    ...tool-specific fields
+}
+```
+
+## Logging
+
+Logs are written to stderr with format:
+```
+[TOOL START] tool_name: arguments
+[TOOL END] tool_name
+[TOOL ERROR] tool_name: error message
+```
+
+## Differences from TypeScript Implementation
+
+1. **Async/Await**: Python version uses async/await instead of Promise-based TypeScript
+2. **Module Organization**: Simplified into single Python files instead of separate TypeScript modules
+3. **Error Handling**: Try-catch blocks instead of TypeScript error handling
+4. **Type System**: Uses type hints instead of TypeScript types
+
+## Contributing
+
+To add new tools:
+
+1. Create a function in the appropriate `tools_*.py` file
+2. Register it in `server.py` in the `register_tools()` function
+3. Document the tool parameters and return values
+
+## License
+
+Same as parent appium-mcp project.
+
+## Related
+
+- [TypeScript Implementation](../appium-mcp/README.md)
+- [Appium Documentation](https://appium.io)
+- [MCP Specification](https://modelcontextprotocol.io)