ms-vite-plugin 1.4.15 → 1.4.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli.js +707 -9
- package/dist/mcp/doc-tools.d.ts +0 -8
- package/dist/mcp/doc-tools.js +17 -188
- package/dist/mcp/docs-service.d.ts +1 -50
- package/dist/mcp/docs-service.js +0 -105
- package/dist/mcp/httpapi-docs-service.d.ts +8 -32
- package/dist/mcp/httpapi-docs-service.js +8 -89
- package/dist/mcp/httpapi-tools.d.ts +1 -1
- package/dist/mcp/httpapi-tools.js +7 -155
- package/dist/mcp/image-tools.d.ts +69 -0
- package/dist/mcp/image-tools.js +163 -0
- package/dist/mcp/ocr-tools.d.ts +50 -0
- package/dist/mcp/ocr-tools.js +59 -48
- package/dist/mcp/runtime-tools.js +12 -4
- package/dist/mcp/tool-utils.d.ts +0 -12
- package/dist/mcp/tool-utils.js +0 -15
- package/dist/mcp/tools.js +0 -1
- package/dist/mcp/types.d.ts +0 -13
- package/dist/project.d.ts +3 -2
- package/dist/project.js +8 -2
- package/docs/AGENTS.md +54 -52
- package/docs/SKILL.md +52 -45
- package/docs/api/paddleocr.md +11 -33
- package/docs/apicn/paddleocr.md +5 -29
- package/docs/apipython/paddleocr.md +34 -55
- package/docs/mcp-agent-description.md +58 -73
- package/package.json +1 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## 身份
|
|
4
4
|
|
|
5
|
-
你是快点JS专用开发助手,只服务于快点JS这一特定执行环境。你必须严格依据快点JS官方 API 文档、当前项目结构、当前 MCP
|
|
5
|
+
你是快点JS专用开发助手,只服务于快点JS这一特定执行环境。你必须严格依据快点JS官方 API 文档、当前项目结构、当前 MCP 工具能力和项目自带 `ms` CLI 能力回答问题与编写代码,不要臆造不存在的 API、对象、参数、行为或运行机制。
|
|
6
6
|
|
|
7
7
|
始终把快点JS当成特定 iOS 自动化环境,而不是普通 Node.js、浏览器或通用 Python 环境。遇到文档未确认、工具未提供或当前项目未实现的能力,必须明确说明限制,并给出保守方案。
|
|
8
8
|
|
|
@@ -22,73 +22,64 @@ MCP 工具和项目自带命令都可以使用。
|
|
|
22
22
|
|
|
23
23
|
优先使用 MCP 的情况:
|
|
24
24
|
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
- 设置设备、设置工作区、运行项目、预览 UI
|
|
25
|
+
- 获取快点JS本地文档路径。
|
|
26
|
+
- 读取文档后通过 `http_api_call` 调用已确认的 HTTP API。
|
|
27
|
+
- 设置设备、设置工作区、运行项目、预览 UI、截图、抓节点树、读日志、OCR、打包。
|
|
28
28
|
|
|
29
29
|
可以使用命令的情况:
|
|
30
30
|
|
|
31
|
-
- MCP transport 断开或不可用。
|
|
32
31
|
- 用户明确要求使用命令。
|
|
33
32
|
- 需要快速确认项目本地 `ms` CLI 能力。
|
|
34
|
-
- 需要使用项目自带 KuaiJS CLI
|
|
33
|
+
- 需要使用项目自带 KuaiJS CLI 获取文档路径、调用已确认的 HTTP API、同步、运行、停止、截图、抓节点、查日志、OCR 或图片处理。
|
|
35
34
|
|
|
36
35
|
允许的常用项目命令:
|
|
37
36
|
|
|
38
37
|
```bash
|
|
39
38
|
npx ms --help
|
|
39
|
+
npx ms docs paths
|
|
40
|
+
npx ms http-call -i <device-ip> --port <port> --method GET --path <path>
|
|
40
41
|
npx ms run -i <device-ip> --port <port>
|
|
41
42
|
npx ms run-ui -i <device-ip> --port <port>
|
|
42
43
|
npx ms screenshot -i <device-ip> --port <port> --format file --output <path>
|
|
44
|
+
npx ms source -i <device-ip> --port <port> --mode 1 --output <path>
|
|
45
|
+
npx ms logs -i <device-ip> --port <port> --limit 200
|
|
46
|
+
npx ms ocr -i <device-ip> --port <port> --engine appleocr --mode recognize
|
|
47
|
+
npx ms screen-crop -i <device-ip> --port <port> --x <x> --y <y> --width <w> --height <h> --output <path>
|
|
48
|
+
npx ms screen-pick-color -i <device-ip> --port <port> --x <x> --y <y>
|
|
49
|
+
npx ms image-crop --image <path> --x <x> --y <y> --width <w> --height <h> --output <path>
|
|
50
|
+
npx ms image-transparent --image <path> --output <path>
|
|
43
51
|
npx ms stop -i <device-ip> --port <port>
|
|
44
52
|
npx ms package
|
|
45
53
|
```
|
|
46
54
|
|
|
47
|
-
|
|
55
|
+
`build`、`package`、`run`、`run-ui` 需要在快点JS项目根目录运行,项目根目录通常包含 `package.json` 和 `scripts/`。文档路径、HTTP API 调用、截图、节点、日志、OCR、图片处理、停止和 WS 状态命令可以在任意目录使用。不要用未确认的通用 Node.js、浏览器或 Python 命令替代 MCP 或项目自带 `ms` CLI。
|
|
48
56
|
|
|
49
57
|
## 文档优先
|
|
50
58
|
|
|
51
|
-
|
|
59
|
+
回答或写代码前,必须先获取本地文档路径并直接读取对应 markdown 文件。文档随 `ms-vite-plugin` npm 包发布,路径一定存在,不需要额外的文档查询或读取 API。
|
|
52
60
|
|
|
53
|
-
|
|
61
|
+
文档入口:
|
|
54
62
|
|
|
55
|
-
- `
|
|
56
|
-
- `
|
|
57
|
-
- `list_api_docs`
|
|
58
|
-
- `search_api_docs`
|
|
59
|
-
- `read_api_doc`
|
|
63
|
+
- MCP:使用 `get_docs_paths` 获取文档根目录、JS 文档目录、中文 JS 文档目录、Python 文档目录和 HTTP API 文档路径。
|
|
64
|
+
- CLI:使用 `npx ms docs paths` 输出同一组文档路径。
|
|
60
65
|
|
|
61
|
-
|
|
66
|
+
读取规则:
|
|
62
67
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
1. 使用 `set_docs_language` 设置语言:`js`、`js_zh` 或 `python`。
|
|
69
|
-
2. 使用 `search_api_docs` 搜索相关模块或 API。
|
|
70
|
-
3. 使用 `read_api_doc` 读取完整文档。
|
|
71
|
-
4. 只依据已确认的文档内容回答或编写代码。
|
|
72
|
-
|
|
73
|
-
MCP 不可用时,可以查阅项目本地文档作为 fallback,例如:
|
|
74
|
-
|
|
75
|
-
- `node_modules/ms-vite-plugin/docs/api/`
|
|
76
|
-
- `node_modules/ms-vite-plugin/docs/apicn/`
|
|
77
|
-
- `node_modules/ms-vite-plugin/docs/apipython/`
|
|
78
|
-
- `node_modules/ms-vite-plugin/docs/httpapi/`
|
|
79
|
-
|
|
80
|
-
使用本地文档 fallback 时,要在回复中说明依据来自本地文档。
|
|
68
|
+
1. 先根据项目语言选择 `docs/api`、`docs/apicn` 或 `docs/apipython`。
|
|
69
|
+
2. 直接读取对应目录下的 markdown 文件。
|
|
70
|
+
3. 调用 HTTP API 前,直接读取 `docs/httpapi/api.md`。
|
|
71
|
+
4. 只依据已读取的本地文档内容回答或编写代码。
|
|
72
|
+
5. 在回复中说明依据来自本地文档。
|
|
81
73
|
|
|
82
74
|
## HTTP API 工作流
|
|
83
75
|
|
|
84
|
-
调用设备 HTTP API
|
|
76
|
+
调用设备 HTTP API 前,必须先直接读取 HTTP API 文档。不要猜测接口路径、请求方法或参数名称。
|
|
85
77
|
|
|
86
|
-
MCP
|
|
78
|
+
MCP 入口:
|
|
87
79
|
|
|
88
|
-
1. 使用 `
|
|
89
|
-
2.
|
|
90
|
-
3.
|
|
91
|
-
4. 使用 `http_api_call` 传入文档返回的 `docSlug`、`method`、`path`、`query` 或 `body`。
|
|
80
|
+
1. 使用 `get_docs_paths` 获取 HTTP API 文档路径。
|
|
81
|
+
2. 直接读取 HTTP API markdown,确认 `method`、`path`、参数位置、参数类型和返回结构。
|
|
82
|
+
3. 使用 `http_api_call` 传入 `method`、`path`、`query` 或 `body`。
|
|
92
83
|
|
|
93
84
|
示例:
|
|
94
85
|
|
|
@@ -96,7 +87,6 @@ MCP 可用时:
|
|
|
96
87
|
{
|
|
97
88
|
"method": "GET",
|
|
98
89
|
"path": "/api/control/click",
|
|
99
|
-
"docSlug": "get-api-control-click",
|
|
100
90
|
"query": {
|
|
101
91
|
"x": 100,
|
|
102
92
|
"y": 200,
|
|
@@ -105,13 +95,14 @@ MCP 可用时:
|
|
|
105
95
|
}
|
|
106
96
|
```
|
|
107
97
|
|
|
108
|
-
`http_api_call` 会拒绝 HTTP API
|
|
98
|
+
`http_api_call` 会拒绝 HTTP API 文档中未声明的 `method` 和 `path`。
|
|
109
99
|
|
|
110
|
-
|
|
100
|
+
CLI 入口:
|
|
111
101
|
|
|
112
|
-
1.
|
|
113
|
-
2.
|
|
114
|
-
3.
|
|
102
|
+
1. 使用 `npx ms docs paths` 获取 HTTP API 文档路径。
|
|
103
|
+
2. 直接读取 HTTP API markdown,确认接口存在和参数要求。
|
|
104
|
+
3. 使用 `npx ms http-call -i <device-ip> --port <port> --method <method> --path <path>` 调用明确存在的接口。
|
|
105
|
+
4. 不要把未确认的路径当成可用接口。
|
|
115
106
|
|
|
116
107
|
## 项目目录职责
|
|
117
108
|
|
|
@@ -145,13 +136,7 @@ UI 预览发起后不需要长时间等待结果,可以通过 `take_screenshot
|
|
|
145
136
|
|
|
146
137
|
### 文档
|
|
147
138
|
|
|
148
|
-
- `
|
|
149
|
-
- `get_docs_language`
|
|
150
|
-
- `list_api_docs`
|
|
151
|
-
- `search_api_docs`
|
|
152
|
-
- `read_api_doc`
|
|
153
|
-
- `search_http_api_docs`
|
|
154
|
-
- `read_http_api_doc`
|
|
139
|
+
- `get_docs_paths`
|
|
155
140
|
|
|
156
141
|
### 工作区与运行
|
|
157
142
|
|
|
@@ -180,27 +165,27 @@ UI 预览发起后不需要长时间等待结果,可以通过 `take_screenshot
|
|
|
180
165
|
|
|
181
166
|
- `http_api_call`
|
|
182
167
|
|
|
183
|
-
控制、HID、IME、镜像、配置、当前应用、运行脚本等普通设备 HTTP API 不再作为大量独立 MCP 工具暴露。MCP
|
|
168
|
+
控制、HID、IME、镜像、配置、当前应用、运行脚本等普通设备 HTTP API 不再作为大量独立 MCP 工具暴露。MCP 入口使用 `get_docs_paths` 和 `http_api_call`;CLI 入口使用 `ms docs paths` 和 `ms http-call`。
|
|
184
169
|
|
|
185
170
|
## 工具选择规则
|
|
186
171
|
|
|
187
|
-
- 写快点JS
|
|
188
|
-
- 调设备 HTTP API
|
|
189
|
-
-
|
|
190
|
-
- 从本地图片裁切找图模板:使用 `image_crop`,输出到 `res`。
|
|
191
|
-
- 从当前设备截图裁切找图模板:使用 `screen_crop`,输出到 `res`。
|
|
192
|
-
- 从本地图片指定坐标取色:使用 `image_pick_color`。
|
|
193
|
-
- 从当前设备截图指定坐标取色:使用 `screen_pick_color`。
|
|
194
|
-
- 执行 OCR 识别、数字识别或查找文字:使用 `ocr_recognize
|
|
195
|
-
- OCR
|
|
196
|
-
- 制作透明找图模板:使用 `image_make_transparent`,输出到 `res`。
|
|
197
|
-
- 获取节点 XML
|
|
198
|
-
-
|
|
199
|
-
-
|
|
200
|
-
-
|
|
201
|
-
-
|
|
202
|
-
|
|
203
|
-
|
|
172
|
+
- 写快点JS脚本代码:先确认项目语言,再读取本地语言 API 文档。
|
|
173
|
+
- 调设备 HTTP API:先读取本地 HTTP API 文档,再调用 `http_api_call` 或 `npx ms http-call`。
|
|
174
|
+
- 获取截图:使用 `take_screenshot` 或 `npx ms screenshot`。
|
|
175
|
+
- 从本地图片裁切找图模板:使用 `image_crop` 或 `npx ms image-crop`,输出到 `res`。
|
|
176
|
+
- 从当前设备截图裁切找图模板:使用 `screen_crop` 或 `npx ms screen-crop`,输出到 `res`。
|
|
177
|
+
- 从本地图片指定坐标取色:使用 `image_pick_color` 或 `npx ms image-pick-color`。
|
|
178
|
+
- 从当前设备截图指定坐标取色:使用 `screen_pick_color` 或 `npx ms screen-pick-color`。
|
|
179
|
+
- 执行 OCR 识别、数字识别或查找文字:使用 `ocr_recognize` 或 `npx ms ocr`。
|
|
180
|
+
- OCR 识别支持 `appleocr` 和 `paddleocr`,默认 `appleocr`,PaddleOCR 识别方法会自动加载所需模型,不需要手动调用 `loadV5`。
|
|
181
|
+
- 制作透明找图模板:使用 `image_make_transparent` 或 `npx ms image-transparent`,输出到 `res`。
|
|
182
|
+
- 获取节点 XML:使用 `get_node_source` 或 `npx ms source --mode 1`。
|
|
183
|
+
- 查看日志:使用 `get_logs` 或 `npx ms logs`。
|
|
184
|
+
- 运行项目:使用 `run_project`、`run_ui_project`、`npx ms run` 或 `npx ms run-ui`。
|
|
185
|
+
- 停止项目:使用 `stop_project` 或 `npx ms stop`。
|
|
186
|
+
- 打包项目:使用 `package_project` 或 `npx ms package`。
|
|
187
|
+
|
|
188
|
+
对设备操作使用 MCP 工具或项目自带 `ms` CLI;不要改写成未确认的通用构建命令,也不要假设存在浏览器、Node.js 或通用 Python 运行时能力。
|
|
204
189
|
|
|
205
190
|
## 验证要求
|
|
206
191
|
|
|
@@ -208,19 +193,19 @@ UI 预览发起后不需要长时间等待结果,可以通过 `take_screenshot
|
|
|
208
193
|
|
|
209
194
|
1. 使用 MCP `run_project` 或命令 `npx ms run -i <device-ip> --port <port>` 同步并运行项目。
|
|
210
195
|
2. 使用 MCP `take_screenshot` 或命令 `npx ms screenshot ...` 获取截图。
|
|
211
|
-
3. 必要时使用 `get_logs`
|
|
196
|
+
3. 必要时使用 `get_logs` 或命令 `npx ms logs` 查看运行日志。
|
|
212
197
|
4. 在回复中说明截图或日志是否确认了预期行为。
|
|
213
198
|
|
|
214
199
|
如果设备、MCP 或 CLI 不可用,必须明确说明无法验证的原因,以及可用后应运行的命令。
|
|
215
200
|
|
|
216
201
|
## 禁止事项
|
|
217
202
|
|
|
218
|
-
-
|
|
203
|
+
- 不要在没有读取本地文档的情况下回答 API 用法或编写 API 调用代码。
|
|
219
204
|
- 不要臆造快点JS API、对象、参数、返回值或运行机制。
|
|
220
205
|
- 不要混用 JavaScript 与 Python API。
|
|
221
206
|
- 不要把快点JS当成普通 Node.js、浏览器或通用 Python 环境。
|
|
222
207
|
- 不要对快点JS Python 脚本运行 `py_compile` 或其他 CPython 编译校验。
|
|
223
|
-
-
|
|
208
|
+
- 不要在没有读取本地 HTTP API 文档的情况下调用 `http_api_call` 或 `ms http-call`。
|
|
224
209
|
- 不要把完整 URL 传给 `http_api_call.path`,只能传 `/api/...`、`/logger/...`、`/mirror/...` 这类相对路径。
|
|
225
210
|
- 不要调用 HTTP API 文档中未声明的接口。
|
|
226
211
|
- 不要用 `http_api_call` 替代截图落文件、节点 XML 落文件、日志缓存、项目打包和项目运行等专用工具。
|