Metadata-Version: 2.4
Name: ascript-mcp
Version: 1.4.0
Summary: AScript MCP Service - 为大模型提供 ascript 自动化库 API 文档与设备交互服务
License: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: mcp>=1.0.0
Requires-Dist: uvicorn>=0.30.0
Requires-Dist: starlette

# ascript-mcp

AScript MCP Service — 让 AI 编程工具（Cursor / Trae）直接查询 AScript API 文档、操控 Android/iOS 设备。

## 功能

- **API 文档查询**：模块概览、API 搜索、代码示例、环境搭建指南
- **在线插件查询**：实时查询 AScript 插件库（OCR、YOLO、HID、大模型等）
- **设备交互**：截图、控件树、OCR、找色、比色、选择器测试
- **开发部署**：创建工程、上传代码、运行、停止、查看日志
- **设备管理**：局域网扫描、ADB 扫描、自动连接

## 安装

```bash
pip install ascript-mcp
```

## 配置 Cursor

### 1. MCP 配置

在项目根目录创建 `.cursor/mcp.json`：

```json
{
  "mcpServers": {
    "ascript": {
      "command": "python",
      "args": ["-m", "ascript_mcp.local"]
    }
  }
}
```

### 2. 规则配置

在项目根目录创建 `.cursorrules` 文件：

```
当用户需要编写设备自动化脚本（Android/iOS/Windows）时，必须使用 ascript MCP 工具连接设备、观察界面、查询 API 后再编写代码，禁止凭记忆编写 ascript 代码。
```

## 工具列表

### API 文档（5 个）
| 工具 | 说明 |
|------|------|
| `get_platform_overview` | 获取平台 API 模块概览 |
| `get_module_apis` | 获取模块详细 API 文档 |
| `search_api` | 按关键词搜索 API |
| `get_code_example` | 获取代码示例 |
| `get_setup_guide` | 获取环境搭建指南 |

### 在线插件（2 个）
| 工具 | 说明 |
|------|------|
| `list_plugins` | 查询插件库列表 |
| `get_plugin_detail` | 获取插件详细文档 |

### 设备连接（3 个）
| 工具 | 说明 |
|------|------|
| `auto_connect` | 从工程配置自动连接设备 |
| `scan_devices` | 扫描局域网 + ADB 设备 |
| `connect_device` | 手动连接指定设备 |

### 观察界面（6 个）
| 工具 | 说明 |
|------|------|
| `screen_capture` | 截取设备屏幕 |
| `dump_ui_tree` | 获取控件树 |
| `test_selector` | 测试选择器是否匹配 |
| `ocr` | 屏幕文字识别 |
| `find_colors` | 多点找色 |
| `compare_colors` | 多点比色 |

### 开发部署（5 个）
| 工具 | 说明 |
|------|------|
| `create_project` | 在设备上创建工程 |
| `upload_file` | 上传文件到设备（自动创建工程） |
| `run_project` | 运行工程 |
| `stop_project` | 停止运行 |
| `get_run_log` | 获取运行日志 |

### 文件管理（2 个）
| 工具 | 说明 |
|------|------|
| `list_projects` | 列出设备上的工程 |
| `get_project_files` | 获取工程文件树 |

## 线上 SSE 模式

如需部署为公网服务（仅 API 文档查询）：

```bash
uvicorn ascript_mcp.server:app --host 0.0.0.0 --port 8000
```

## 更多信息

- AScript 官网：https://airscript.cn
- API 文档：https://docs.airscript.cn
