uiautomator2-mcp-server 0.1.2__tar.gz → 0.2.0__tar.gz

uiautomator2_mcp_server-0.2.0/CHANGELOG.md

@@ -0,0 +1,88 @@
+# CHANGELOG
+
+## 0.2.0
+
+> 📅 2026-02-05
+
+- ⛓️‍💥 Breaking:
+    - CLI now requires explicit subcommand (`http`, `stdio`, `tools`, `info`, `tags`, or `version`). Running `u2mcp` without arguments shows help instead of starting server with default stdio transport. Migrate by appending `stdio` to your command: `u2mcp` → `u2mcp stdio`
+    - Change project license from MIT to Apache-2.0
+
+- 🆕 New:
+    - Add CLI short options: `-l` (log-level), `-i` (include-tags), `-e` (exclude-tags), `-H` (host), `-p` (port), `-t` (token), `-n` (no-token)
+    - Add `--show-fastmcp-banner` option to stdio and http commands to control fastmcp banner display
+    - Add `save_screenshot` tool to save screenshots to file with format determined by extension
+    - Add AI-driven UI testing framework with comprehensive test specification
+    - Add Android UI test skill as dual-purpose educational example and production test suite
+    - Add CLI utility commands: `u2mcp tools`, `u2mcp info <tool>`, `u2mcp tags`, `u2mcp version`
+    - Add tag-based tool filtering with wildcard support (`--include-tags`, `--exclude-tags`)
+    - Add `element_bounds` tool to get bounding box coordinates of elements
+    - Add clipboard read/write tools: `read_clipboard`, `write_clipboard`
+    - Add `hide_keyboard` input tool
+    - Add new element interaction tools: `element_get_text`, `element_set_text`
+    - Add `purge` device tool to remove all resources from device
+    - Add `shell_command` tool to run arbitrary shell commands with timeout
+    - Add ADB availability check at startup with `--check-adb/--no-check-adb` option
+    - Add `version` CLI option to display version information
+    - Add alternative CLI entry points: `uiautomator2-mcp`, `uiautomator2-mcp-server`
+
+- ⚙️ Changed:
+    - Refactor CLI with cyclopts subcommands (migrated from typer)
+    - Move tag parsing and wildcard expansion logic to mcp module
+    - Rename `_version.py` to `version.py`
+    - Rename `monitor_task_group` to `background_task_group`
+    - Rename internal `tags` variable to `tags_map` for clarity
+    - Update `shell_command` to return exit code and output
+    - Enhance ADB connectivity check with detailed information and platform-specific guidance
+
+- 🐛 Fixed:
+    - Add `serial_optional=None` parameter to argparse.Namespace in the init tool
+    - Improve scrcpy error handling for process exit during startup
+    - Correct scrcpy tool name and add Windows executable support
+    - Fix `element_bounds` tool - `bounds` is a property, not a method
+    - Correct help command reference in breaking changes documentation
+
+- 📚 Docs:
+    - Add CLAUDE.md with comprehensive project documentation
+    - Add CLI utility commands documentation to README
+    - Add tool tagging system documentation
+    - Add installation guides for uv and pipx
+    - Add Chinese translation to README
+    - Add code of conduct and contribution guidelines
+    - Add ADB troubleshooting guidance
+    - Add AI-driven UI testing documentation to README (English and Chinese)
+
+- 🧪 Tests:
+    - Enhance u2 device mock with comprehensive functionality
+    - Add AI-driven UI testing skill with comprehensive test specification
+
+- 🐎 Chores:
+    - Update check-jsonschema version
+    - Add .gitignore file for local config
+    - Adjust pre-commit configuration
+
+## 0.1.3
+
+> 📅 2026-01-23
+
+- 🐛 Fixed: Python 3.11 compatibility (added `typing_extensions` dependency)
+
+## 0.1.2
+
+> 📅 2026-01-09
+
+- ⛓️‍💥 Breaking:
+    - http/stdio transport is now a required command line argument, user should choose either `http` or `stdio`, `stdio` is the default.
+
+- 🆕 New:
+    - Added Authorization bearer token verification
+    - Added `--log-level` command line argument
+
+- 🗑️ Removed:
+    - Removed the feature that http/stdio transports run at the same
+
+## 0.1.1
+
+> 📅 2026-01-06
+
+An early release.

uiautomator2_mcp_server-0.2.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,23 @@
+# Code of Conduct
+
+We value an open, inclusive, and harassment-free community for contributors and users of uiautomator2-mcp-server. All participants are expected to be respectful and professional.
+
+## Our Standards
+- Be respectful and considerate in all interactions.
+- Communicate openly and assume good intentions.
+- Avoid demeaning, discriminatory, or harassing behavior and language.
+- Be collaborative and constructive when giving feedback.
+
+## Unacceptable Behavior
+Harassment, hateful language, derogatory comments, threats, or other abusive behaviors will not be tolerated.
+
+## Reporting and Enforcement
+If you experience or witness unacceptable behavior, please report it to the project maintainers:
+
+- Open an issue labeled `code-of-conduct` or
+- Email: tanbro@163.com
+
+Reports will be handled promptly and confidentially. Maintainers may take actions including warnings, requested changes, or removal of access when necessary.
+
+## Reference
+This policy is aligned with the Contributor Covenant principles. For the full reference see: https://www.contributor-covenant.org/

uiautomator2_mcp_server-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,310 @@
+# Contributing to uiautomator2-mcp-server
+
+Thank you for your interest in contributing to uiautomator2-mcp-server! This document provides guidelines and instructions for contributing to the project.
+
+## Code of Conduct
+
+This project adheres to a code of conduct that all contributors are expected to follow:
+- Be respectful and inclusive
+- Provide constructive feedback
+- Focus on what is best for the community
+- Show empathy towards other community members
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.11 or higher
+- Git
+- ADB (Android Debug Bridge) - only needed for integration tests
+- An Android device with USB debugging enabled - only needed for integration tests
+
+### Setting Up Your Development Environment
+
+1. **Fork and clone the repository:**
+   ```bash
+   git clone https://github.com/your-username/uiautomator2-mcp-server.git
+   cd uiautomator2-mcp-server
+   ```
+
+2. **Install development dependencies:**
+   ```bash
+   # Install uv (recommended)
+   curl -LsSf https://astral.sh/uv/install.sh | sh  # Linux/macOS
+   # or
+   powershell -c "irm https://astral.sh/uv/install.ps1 | iex"  # Windows
+
+   # Install dependencies using uv
+   uv sync --dev
+   ```
+
+3. **Activate the virtual environment:**
+   ```bash
+   # Linux/macOS
+   source .venv/bin/activate
+
+   # Windows (PowerShell)
+   .venv\Scripts\activate
+   ```
+
+4. **Install pre-commit hooks (highly recommended):**
+   ```bash
+   pre-commit install
+   ```
+
+   This will automatically run linters and formatters before each commit.
+
+## Development Workflow
+
+### Running Tests
+
+We use pytest for testing. Tests are organized into:
+- **Unit tests** (`tests/unit/`) - Fast tests that don't require external dependencies
+- **Integration tests** (`tests/integration/`) - Tests that require a real Android device
+
+```bash
+# Run all tests
+pytest
+
+# Run only unit tests (fast, no device required)
+pytest -m unit
+
+# Run integration tests (requires Android device)
+pytest -m integration
+
+# Run with coverage report
+pytest --cov=src/u2mcp --cov-report=html --cov-report=term-missing
+
+# Run a specific test file
+pytest tests/unit/test_device.py
+
+# Run a specific test
+pytest tests/unit/test_device.py::test_device_list
+```
+
+### Test Markers
+
+We use pytest markers to categorize tests:
+- `unit` - Unit tests (fast, no external dependencies)
+- `integration` - Integration tests (require Android device)
+- `slow` - Slow running tests
+- `device` - Tests that require actual Android device
+
+### Writing Tests
+
+When adding new features, please include appropriate tests:
+
+1. **Unit Tests:** Mock external dependencies (uiautomator2, adbutils)
+   ```python
+   from unittest.mock import AsyncMock, MagicMock, patch
+
+   @pytest.mark.unit
+   async def test_my_tool(mock_u2_device: MagicMock):
+       # Arrange
+       mock_u2_device.some_method.return_value = "expected"
+
+       # Act
+       result = await my_tool(serial="test-device")
+
+       # Assert
+       assert result == "expected"
+   ```
+
+2. **Integration Tests:** Test against real device (when applicable)
+   ```python
+   @pytest.mark.integration
+   @pytest.mark.device
+   async def test_my_tool_real_device():
+       # This test requires a connected device
+       result = await my_tool(serial="emulator-5554")
+       assert result is not None
+   ```
+
+### Code Style
+
+This project uses:
+- **Ruff** for linting and formatting
+- **mypy** for type checking
+- **pre-commit** for automated checks
+
+```bash
+# Run linter
+ruff check src/
+
+# Auto-fix linting issues
+ruff check --fix src/
+
+# Format code
+ruff format src/
+
+# Type check
+mypy src/
+```
+
+Pre-commit hooks will automatically run these checks before each commit if you have them installed.
+
+### Project Structure
+
+```
+src/u2mcp/
+├── __init__.py          # Package init, exports version info
+├── __main__.py          # Entry point for CLI commands
+├── _version.py          # Auto-generated version info (SCM)
+├── mcp.py               # MCP server factory and configuration
+├── background.py        # Background task management
+├── health.py            # ADB availability check
+└── tools/
+    ├── __init__.py      # Tools registry
+    ├── device.py        # Device management tools
+    ├── action.py        # Touch/gesture tools
+    ├── app.py           # App management tools
+    ├── clipboard.py     # Clipboard read/write tools
+    ├── element.py       # Element/UI interaction tools
+    ├── misc.py          # Miscellaneous tools
+    └── scrcpy.py        # Screen mirroring (scrcpy integration)
+
+tests/
+├── conftest.py          # Pytest configuration and fixtures
+├── unit/                # Fast unit tests
+└── integration/         # Integration tests requiring real devices
+```
+
+## Adding New Tools
+
+To add a new MCP tool:
+
+1. **Choose the appropriate module** in `src/u2mcp/tools/` based on functionality
+2. **Create the tool function** with appropriate type hints:
+   ```python
+   from __future__ import annotations
+   from typing import Any
+
+   from u2mcp.mcp import mcp
+   from u2mcp.device import get_device
+   from anyio import to_thread
+
+   @mcp.tool("my_tool")
+   async def my_tool(serial: str, param: str) -> dict[str, Any]:
+       """
+       Brief description of what the tool does.
+
+       Args:
+           serial: Device serial number
+           param: Description of parameter
+
+       Returns:
+           Dictionary with result information
+       """
+       async with get_device(serial) as device:
+           result = await to_thread.run_sync(lambda: device.some_method(param))
+       return {"result": result}
+   ```
+
+3. **Add tests** for the new tool in `tests/unit/` or `tests/integration/`
+4. **Update documentation** in [README.md](README.md) if needed
+5. **Run tests and linting** to ensure everything passes
+6. **Commit and create a pull request**
+
+## Pull Request Process
+
+1. **Create a new branch** from `main`:
+   ```bash
+   git checkout -b feature/your-feature-name
+   # or
+   git checkout -b fix/your-bug-fix
+   ```
+
+2. **Make your changes** following the guidelines above
+
+3. **Commit your changes** with clear, descriptive messages:
+   ```bash
+   git add .
+   git commit -m "feat: add new tool for XYZ"
+   # Use conventional commits: feat:, fix:, docs:, chore:, etc.
+   ```
+
+4. **Push to your fork**:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+5. **Create a Pull Request** on GitHub with:
+   - Clear title and description
+   - Reference related issues (if any)
+   - Screenshots or examples for UI changes (if applicable)
+   - Confirmation that all tests pass
+   - Confirmation that pre-commit hooks pass
+
+### PR Review Checklist
+
+Before submitting a PR, ensure:
+- [ ] All tests pass (`pytest`)
+- [ ] Code is formatted (`ruff format`)
+- [ ] No linting errors (`ruff check`)
+- [ ] Type checking passes (`mypy`)
+- [ ] New features include tests
+- [ ] Documentation is updated (if needed)
+- [ ] Commit messages follow conventional commit format
+
+## Release Process
+
+Releases are managed by the maintainers through GitHub releases:
+
+1. Maintainers create a new git tag following PEP 440 versioning
+2. The CI pipeline automatically:
+   - Validates the tag format
+   - Runs all tests
+   - Builds the package
+   - Publishes to PyPI
+
+Please don't create tags yourself unless you're a maintainer.
+
+## Coverage Requirements
+
+We aim to maintain good test coverage. Currently:
+- CI runs coverage reports on all tests
+- Coverage is uploaded to Codecov for tracking
+
+**Goal:** We're working toward increasing coverage, especially in the `tools/` modules. Contributions that improve test coverage are highly appreciated!
+
+## Getting Help
+
+If you need help:
+- Check existing [GitHub Issues](https://github.com/tanbro/uiautomator2-mcp-server/issues)
+- Read the [README.md](README.md) for usage documentation
+- Review existing tests for examples
+- Ask questions in a new GitHub Issue with the `question` label
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the [GPL-3.0-or-later](LICENSE) license.
+
+## Style Guidelines
+
+### Python Code
+
+- Use Python 3.11+ syntax
+- All function signatures must include type hints
+- Use `from __future__ import annotations` for deferred evaluation
+- Use `typing_extensions` for compatibility with Python < 3.12
+- Follow PEP 8 style guide (enforced by ruff)
+
+### Documentation
+
+- Use docstrings for all public functions, classes, and modules
+- Keep docstrings clear and concise
+- Update README.md when adding user-facing features
+
+### Localization & Multi-language Policy
+
+- Keep region-specific instructions (for example, Mainland China `pip`/`uv` mirror configuration) inside the corresponding language README (e.g., `README.zh-CN.md`).
+- Do **not** duplicate region-only instructions into the English README. Instead, add a short navigation note in the English README pointing to the language specific file when appropriate (e.g., "See `README.zh-CN.md` for Mainland China-specific mirror instructions").
+- Ensure translations are accurate and avoid adding region-specific content to all language files unless it is globally applicable.
+
+### Async/Await
+
+- Use `async/await` for all I/O operations
+- Use `to_thread.run_sync()` for CPU-bound operations
+- Use `get_device()` context manager for device access
+
+Thank you for contributing to uiautomator2-mcp-server!

uiautomator2_mcp_server-0.2.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024-2025 tanbro
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

uiautomator2_mcp_server-0.2.0/MANIFEST.in

@@ -0,0 +1,11 @@
+exclude .*
+exclude CLAUDE.md
+exclude coverage.*
+exclude pytest.ini
+exclude README.*.md
+exclude *.lock
+
+prune .*
+prune docs
+prune htmlcov
+prune tests