@qing3a/flow-rpa-app 0.4.1 → 0.4.3

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/README.md ADDED
@@ -0,0 +1,56 @@
1
+ # flow-rpa-app —— 本地 RPA 执行引擎(给 Agent 用)
2
+
3
+ flow-rpa 是本地 RPA 引擎:解释执行**流程定义**(JSON 数据),拟人化操作用户本地的浏览器(CDP),
4
+ 产生结构化执行记录。**使用者是用户的 Agent**:用户只给一句话 + 本包名,Agent 按下面序列自举,
5
+ 人工只做「引擎浏览器登录一次」。
6
+
7
+ ## 安装与自举(Agent 按序执行)
8
+
9
+ ```bash
10
+ # 1. 安装(公共 npm;镜像同步延迟时加 --registry=https://registry.npmjs.org)
11
+ npm i -g @qing3a/flow-rpa-app
12
+
13
+ # 2. 初始化(创建数据/流程目录 + 引导)
14
+ flow-app init
15
+
16
+ # 3. 体检(目录/流程解析/Edge/锁)——必须通过项:目录、流程解析、无警告、锁;
17
+ # 平台未配置项可忽略(仅影响观察/流程同步,本地模式正常使用)
18
+ flow-app doctor
19
+
20
+ # 4. 启动常驻服务(--http-port 可改;--edge 必填:从零环境无 9222 调试实例时引擎靠它拉起专用浏览器)
21
+ flow-app --http --http-port 3111 --flows <流程目录> --data <数据目录> --edge "<Edge 可执行文件路径>"
22
+ # Windows 默认路径示例:C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe
23
+ # 替代:外部已用 --remote-debugging-port=9222 拉起 Edge 时可省略 --edge(引擎复用调试实例)
24
+
25
+ # 5. 挂引擎级 skill 到 Agent 平台的 skills 目录(幂等,带版本标注)
26
+ flow-app install-skill <你的 skills 目录>
27
+ ```
28
+
29
+ - **MCP 地址**:`http://127.0.0.1:3111/mcp`(`--http-port` 可改)
30
+ - **状态页**:`http://127.0.0.1:3111/status.json`(只读:版本/浏览器连接/队列/锁/流程列表)
31
+ - 已装好/已连上的:直接跳过安装,用 `get_status` 预检后跑流程(详见包内 skill)
32
+
33
+ ## Skill 位置
34
+
35
+ - 包内:`skill/flow-rpa-engine.md`(引擎能力说明书:13 个 MCP 工具签名、调用规则、失败处理)
36
+ - `flow-app install-skill <dir>` 自动拷贝到目标目录并标注版本;也可直接从 npm 包目录读
37
+
38
+ ## 首次使用(唯一人工步骤)
39
+
40
+ 引擎用**专用浏览器(独立 profile)**:第一次跑流程前需人工登录目标平台一次。
41
+ **用户日常浏览器登录 ≠ 引擎已登录**(profile 隔离);未登录时报「登录页/未登录」,人工登录后再跑。
42
+
43
+ ## 安全边界
44
+
45
+ - **登录一次**:仅首次人工登录,之后全自动化
46
+ - **防封**:同站节流 15~70s 引擎强制;跑真实流程前**同站冷却 ≥2h 优先**(冷却不足时点击
47
+ 60-500s/次、run 时长拉长——属平台节奏非引擎故障,不要重试/不要绕过闸门)
48
+ - **不做**:无人值守调度(一切由 Agent 对话驱动)、L3 自主探索(不直接操作页面元素)、
49
+ 绕过同站闸门/修改冷却参数、自动应用未成熟建议(结构改动必须人工确认 confirm:true)
50
+
51
+ ## 工具面(13 个 MCP 工具)
52
+
53
+ `get_status` / `list_flows` / `run_flow` / `get_run` / `cancel_run` / `validate_flow`
54
+ (核心执行)+ `list_suggestions` / `apply_suggestion` / `dismiss_suggestion`(学习与建议)
55
+ + `export_observation` / `sync_pending_uploads` / `get_perf` / `pkg_update`(运维,仅 owner)。
56
+ 签名与调用规则见包内 `skill/flow-rpa-engine.md`。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@qing3a/flow-rpa-app",
3
- "version": "0.4.1",
3
+ "version": "0.4.3",
4
4
  "type": "module",
5
5
  "description": "flow-rpa 应用壳(原 app crate):MCP server + CLI",
6
6
  "publishConfig": {
@@ -28,7 +28,7 @@
28
28
  "typecheck": "tsc --noEmit"
29
29
  },
30
30
  "dependencies": {
31
- "@qing3a/flow-rpa-engine": "^0.4.1",
31
+ "@qing3a/flow-rpa-engine": "^0.4.3",
32
32
  "@modelcontextprotocol/sdk": "^1.30.0",
33
33
  "zod": "^4.4.3"
34
34
  }
@@ -7,6 +7,44 @@
7
7
 
8
8
  ---
9
9
 
10
+ ## 〇、首次使用/自举(Bootstrap)——从零到能跑
11
+
12
+ > 适用:引擎还没装好(Agent 接到任务时)。已装好/已连上的跳过本节,直接进「典型调用序列」。
13
+
14
+ ### 0.1 检测是否已安装
15
+
16
+ - 先试 `flow-app doctor`(或 MCP `get_status`):**命令不存在(command not found)或连不上 → 引擎未安装/未启动**
17
+ - `flow-app doctor` 6 项体检(数据/流程目录、流程解析+警告、平台配置、Edge 可执行、单实例锁)——**修到全部通过再继续**
18
+
19
+ ### 0.2 安装序列(依次执行)
20
+
21
+ 1. `npm i -g @qing3a/flow-rpa-app`(公共 npm;镜像同步延迟时加 `--registry=https://registry.npmjs.org`)
22
+ 2. `flow-app init`(创建数据/流程目录 + 4 步引导)
23
+ 3. `flow-app doctor`(体检:目录可写、流程合法、Edge 路径、锁无冲突)
24
+ - **必须通过**:flows/data 目录、流程可解析、流程定义无警告、单实例锁
25
+ - **Edge 项**:传 `--edge <路径>` 后通过(见第 4 步);平台未配置项**可忽略**(仅影响观察/流程同步,本地模式正常使用)
26
+ 4. `flow-app --http --http-port 3111 --flows <流程目录> --data <数据目录> --edge "<Edge 可执行文件路径>"`(启动常驻服务;端口可改)
27
+ - `--edge` 必填(从零环境无 9222 调试实例时,引擎靠它拉起专用浏览器);Windows 默认路径示例:`C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe`
28
+ - 替代:外部已用 `--remote-debugging-port=9222` 拉起 Edge 时可省略(引擎复用调试实例)
29
+ - MCP 地址:`http://127.0.0.1:3111/mcp`;状态页:`http://127.0.0.1:3111/status.json`
30
+ 5. `flow-app install-skill <Agent 的 skills 目录>`(把引擎级 skill 拷到 Agent 平台,覆盖安装幂等,带版本标注)
31
+
32
+ ### 0.3 首次登录(唯一的人工步骤)
33
+
34
+ - 引擎用**专用浏览器(独立 profile)**:第一次跑流程前,人工在引擎浏览器里登录目标平台一次
35
+ - **用户日常浏览器登录 ≠ 引擎已登录**(profile 隔离);未登录时报「登录页/未登录」类错误,告知用户处理,不要重试流程
36
+
37
+ ### 0.4 冷却提示(防封节奏,USAGE-ISSUES #18)
38
+
39
+ - 跑真实流程前**同站冷却 ≥2h 优先**(冷却 ≥5h 实证点击恢复正常 3-6s)
40
+ - 冷却不足时点击动作 60-500s/次、run 时长显著拉长——**属平台节奏,非引擎故障**;不要重试、不要绕过同站闸门
41
+
42
+ ### 0.5 自举完成
43
+
44
+ - 用 `get_status` 预检(浏览器连接/队列/锁/平台配置)→ 进入下文「典型调用序列」
45
+
46
+ ---
47
+
10
48
  ## 一、这是什么
11
49
 
12
50
  flow-rpa 是本地 RPA 执行引擎:它解释执行**流程定义**(JSON 数据),拟人化操作用户本地的浏览器(CDP),产生结构化执行记录,并把脱敏统计上传到协作平台(md-forge)。
@@ -68,6 +106,7 @@ Agent 按自己被赋予的角色调用,超出裁剪集的工具会报「工
68
106
  - **引擎默认使用专用浏览器(独立 profile)**:首次使用需人工登录一次(引擎会拉起自己的浏览器实例,登录目标平台后即可)——登录态与用户日常浏览器**隔离**,用户日常登录 ≠ 引擎已登录
69
107
  - 可选能力:若用户主动以调试模式(9222)启动了浏览器,引擎可复用其登录态(不鼓励给日常浏览器开调试模式——同 profile 双进程有锁冲突风险)
70
108
  - 同站节流:同一站点两次执行间隔**随机 15~70 秒**(引擎强制,2026-08-26 owner 拍板修订,原 ≥10 分钟为起步值);间隔不足会被拒(返回需等待时间)——**不要自行绕过或频繁重试**
109
+ - **冷却节奏(USAGE-ISSUES #18,2026-08-27 诊断)**:目标站点对自动化访问有**交互响应节流**——同站冷却不足(<2h)时点击动作 60-500s/次(run 时长显著拉长);冷却 ≥5h 后点击恢复 3-6s。跑真实流程前**同站冷却 ≥2h 优先**(点击正常且反封安全);冷却不足时预计 run 时长大幅增加,属平台节奏而非引擎故障
71
110
 
72
111
  **参数组装**
73
112
  - `vars` 按 `list_flows` 返回的 `inputs` 声明组装(`{name, required, description}`);值为字符串