Skip to main content

AScript MCP Service - 为大模型提供 ascript 自动化库 API 文档与设备交互服务

Project description

ascript-mcp

中文 | English

PyPI License: MIT Python

AScript MCP Service — 让 AI 编程工具(Claude Desktop / Cursor / Trae)直接查询 AScript API 文档、操控真实 Android / iOS 设备(iOS 免签免越狱)。

功能

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

安装

pip install ascript-mcp

配置 Cursor

1. MCP 配置

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

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

2. 规则配置

docs/AGENT_RULES.md 完整复制到你的自动化工程根目录的 .cursorrules(Cursor)或 CLAUDE.md / AGENTS.md(Claude Code / 其他 IDE)。

这份规则模板包含:

  • 5 阶段标准工作流(先观察 → 选策略 → eval_python 迭代 → 必要时裁图 → 上传运行)
  • 选 API 的决策树(控件 → OCR → 找图 → 找色)
  • 自动登录 / 签到 / 游戏战斗等常见任务的编排范例
  • 反模式清单(凭空猜代码、不验证就 run、硬编码不存在的图片路径等)

简版规则(仅当你不想复制完整规则时用):

当用户需要编写设备自动化脚本(Android/iOS/Windows)时,必须先调用 ascript MCP 的
get_device_status 与 list_python_packages,再用 eval_python 在设备 REPL 里
验证关键代码片段,最后才 upload_file + run_project。
禁止凭记忆编写 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 获取插件详细文档

设备连接(5 个)

工具 说明
auto_connect 从工程配置自动连接设备
scan_devices 扫描局域网 + ADB 设备
connect_device 手动连接指定设备
get_device_status 获取设备完整运行状态(运行模式/权限/屏幕/电池/内存/正在跑的脚本等,仅 Android)
list_python_packages 列出设备 AScript App 已安装的 Python 第三方库(Android + iOS)

观察界面(6 个)

工具 说明
screen_capture 截取设备屏幕
dump_ui_tree 获取控件树
test_selector 测试选择器是否匹配
ocr 屏幕文字识别
find_colors 多点找色
compare_colors 多点比色

开发部署(7 个)

工具 说明
create_project 在设备上创建工程
upload_file 上传文件到设备(自动创建工程)
run_project 运行工程
run_project_debug 调试模式运行(Android + ADB),自动 forward 5678 端口并返回 VS Code attach 配置
stop_project 停止运行
get_run_log 获取运行日志
eval_python 设备 Python REPL(Android + iOS):直接在主进程 exec 代码立即拿结果,几百毫秒一轮。适合探索调试、复合决策、自定义工作流(SoM/智能 tap/自动裁模板等)。iOS 自动转译 ascript.android.*ascript.ios.* 并预加载 cv2/np/Image。详见 AGENT_EVAL_GUIDE

文件管理(2 个)

工具 说明
list_projects 列出设备上的工程
get_project_files 获取工程文件树

线上 SSE 模式

如需部署为公网服务(仅 API 文档查询):

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

License

MIT License,详见 LICENSE。Copyright © 2026 北京奥悦科技有限公司。

更多信息

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

ascript_mcp-1.7.0.tar.gz (167.4 kB view details)

Uploaded Source

Built Distribution

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

ascript_mcp-1.7.0-py3-none-any.whl (172.6 kB view details)

Uploaded Python 3

File details

Details for the file ascript_mcp-1.7.0.tar.gz.

File metadata

  • Download URL: ascript_mcp-1.7.0.tar.gz
  • Upload date:
  • Size: 167.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ascript_mcp-1.7.0.tar.gz
Algorithm Hash digest
SHA256 9ec1487082c9b4810a179144538113718fc6d9094d62fc51237d07efc1b9b978
MD5 d69dd7ddb0e7d6a15d8cd92fff40d55b
BLAKE2b-256 808d9f6e3236db40bcb324d37221d7b70adc5562a31eb761113e54e7c6875917

See more details on using hashes here.

Provenance

The following attestation bundles were made for ascript_mcp-1.7.0.tar.gz:

Publisher: publish.yml on ascript-cn/ascript-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ascript_mcp-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: ascript_mcp-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 172.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ascript_mcp-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6658854c8b1d0c525f46d9d0c88d4dedeec285e8e174f08a47ddf330671ffa11
MD5 e0d9a1dc55865e0d5966d50561d5e430
BLAKE2b-256 b92d55fa17f59e4d5cbf8183f2afec8d8d1b275ae46f0b039c2f93d60a4d144d

See more details on using hashes here.

Provenance

The following attestation bundles were made for ascript_mcp-1.7.0-py3-none-any.whl:

Publisher: publish.yml on ascript-cn/ascript-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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