Skip to content

Commit 9855dfb

Browse files
fix: address mykola review comments (#20)
* address mykola review comments Co-authored-by: Saikrishna321 <[email protected]> * address review comments Co-authored-by: Saikrishna321 <[email protected]> * address review comments Co-authored-by: Saikrishna321 <[email protected]> * fix eslint issues Co-authored-by: Saikrishna321 <[email protected]> --------- Co-authored-by: Saikrishna321 <[email protected]>
1 parent fd38fef commit 9855dfb

22 files changed

+736
-1056
lines changed

CONFIG.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

README.md

Lines changed: 21 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
<div align="center">
2-
<img src="src/assets/jarvislogo.png" alt="Jarvis Appium Logo" width="500"/>
3-
</div>
1+
# MCP Appium - MCP server for Mobile Development and Automation | iOS, Android, Simulator, Emulator, and Real Devices
42

5-
# Jarvis Appium - MCP server for Mobile Development and Automation | iOS, Android, Simulator, Emulator, and Real Devices
6-
7-
Jarvis Appium is an intelligent MCP (Model Context Protocol) server designed to empower AI assistants with a robust suite of tools for mobile automation. It streamlines mobile app testing by enabling natural language interactions, intelligent locator generation, and automated test creation for both Android and iOS platforms.
3+
MCP Appium is an intelligent MCP (Model Context Protocol) server designed to empower AI assistants with a robust suite of tools for mobile automation. It streamlines mobile app testing by enabling natural language interactions, intelligent locator generation, and automated test creation for both Android and iOS platforms.
84

95
## Table of Contents
106

@@ -21,11 +17,9 @@ Jarvis Appium is an intelligent MCP (Model Context Protocol) server designed to
2117
## 🚀 Features
2218

2319
- **Cross-Platform Support**: Automate tests for both Android (UiAutomator2) and iOS (XCUITest).
24-
- **Cloud Integration**: Seamlessly connect with the LambdaTest cloud platform for scalable testing.
2520
- **Intelligent Locator Generation**: AI-powered element identification using priority-based strategies.
26-
- **Interactive Session Management**: Easily create and manage sessions on local and cloud-based mobile devices.
21+
- **Interactive Session Management**: Easily create and manage sessions on local mobile devices.
2722
- **Smart Element Interactions**: Perform actions like clicks, text input, screenshots, and element finding.
28-
- **App Management**: Upload and manage mobile applications on cloud platforms.
2923
- **Automated Test Generation**: Generate Java/TestNG test code from natural language descriptions.
3024
- **Page Object Model Support**: Utilize built-in templates that follow industry best practices.
3125
- **Flexible Configuration**: Customize capabilities and settings for different environments.
@@ -63,17 +57,17 @@ Before you begin, ensure you have the following installed:
6357

6458
### As an MCP Server
6559

66-
To integrate Jarvis Appium with your MCP client, add the following to your configuration:
60+
To integrate MCP Appium with your MCP client, add the following to your configuration:
6761

6862
```json
6963
{
7064
"mcpServers": {
71-
"jarvis-appium": {
65+
"mcp-appium": {
7266
"disabled": false,
7367
"timeout": 100,
7468
"type": "stdio",
7569
"command": "npx",
76-
"args": ["jarvis-appium"],
70+
"args": ["mcp-appium"],
7771
"env": {
7872
"ANDROID_HOME": "/path/to/android/sdk",
7973
"CAPABILITIES_CONFIG": "/path/to/your/capabilities.json"
@@ -114,31 +108,29 @@ Set the `CAPABILITIES_CONFIG` environment variable to point to your configuratio
114108

115109
### Session Management
116110

117-
- `select_platform`: Choose between "android" or "ios".
118-
- `create_session`: Create a new mobile automation session.
119-
- `create_lambdatest_session`: Create a session on the LambdaTest cloud platform.
120-
- `upload_app_lambdatest`: Upload a mobile app to LambdaTest.
121-
- `appium_activate_app`: Activate a specified app.
122-
- `appium_terminate_app`: Terminate a specified app.
111+
- `select_platform`: Choose between "android" or "ios".
112+
- `create_session`: Create a new mobile automation session.
113+
- `appium_activate_app`: Activate a specified app.
114+
- `appium_terminate_app`: Terminate a specified app.
123115

124116
### Element Interaction
125117

126-
- `generate_locators`: Generate intelligent locators for all interactive elements on the current screen.
127-
- `appium_find_element`: Find a specific element using various locator strategies.
128-
- `appium_click`: Click on an element.
129-
- `appium_set_value`: Enter text into an input field.
130-
- `appium_get_text`: Retrieve the text content of an element.
131-
- `appium_screenshot`: Capture a screenshot of the current screen.
132-
- `appium_scroll`: Scroll the screen vertically.
133-
- `appium_scroll_to_element`: Scroll until a specific element is found.
118+
- `generate_locators`: Generate intelligent locators for all interactive elements on the current screen.
119+
- `appium_find_element`: Find a specific element using various locator strategies.
120+
- `appium_click`: Click on an element.
121+
- `appium_set_value`: Enter text into an input field.
122+
- `appium_get_text`: Retrieve the text content of an element.
123+
- `appium_screenshot`: Capture a screenshot of the current screen.
124+
- `appium_scroll`: Scroll the screen vertically.
125+
- `appium_scroll_to_element`: Scroll until a specific element is found.
134126

135127
### Test Generation
136128

137-
- `appium_generate_tests`: Generate automated test code from natural language scenarios.
129+
- `appium_generate_tests`: Generate automated test code from natural language scenarios.
138130

139131
## 🤖 Client Support
140132

141-
Jarvis Appium is designed to be compatible with any MCP-compliant client.
133+
MCP Appium is designed to be compatible with any MCP-compliant client.
142134

143135
## 📚 Usage Examples
144136

@@ -150,26 +142,7 @@ Here's an example prompt to test the Amazon mobile app checkout process:
150142
Open Amazon mobile app, search for "iPhone 15 Pro", select the first search result, add the item to cart, proceed to checkout, sign in with email "[email protected]" and password "testpassword123", select shipping address, choose payment method, review order details, and place the order. Use JAVA + TestNG for test generation.
151143
```
152144

153-
This example demonstrates a complete e-commerce checkout flow that can be automated using Jarvis Appium's intelligent locator generation and test creation capabilities.
154-
155-
```
156-
157-
### LambdaTest Cloud Testing
158-
159-
1. **Upload Your App**:
160-
```
161-
Use upload_app_lambdatest with:
162-
- appPath: "/path/to/your/app.apk"
163-
- appName: "My Test App"
164-
```
165-
2. **Create Cloud Session**:
166-
```
167-
Use create_lambdatest_session with:
168-
- platform: "android"
169-
- deviceName: "Galaxy S21"
170-
- platformVersion: "11.0"
171-
- app: "lt://APP_ID_FROM_UPLOAD"
172-
```
145+
This example demonstrates a complete e-commerce checkout flow that can be automated using MCP Appium's intelligent locator generation and test creation capabilities.
173146

174147
## 🙌 Contributing
175148

0 commit comments

Comments
 (0)