JXY RPA Workflow MCP Server

API Reference v0.1.1 — MCP Tool 入参文档

MCP 配置

{
  "mcpServers": {
    "jxy-rpa-workflow": {
      "command": "uv",
      "args": ["tool", "run", "jxy-rpa-workflow-mcp-server"]
    }
  }
}

1. instruction

RPA 指令查询工具。查询可用的 RPA 指令列表或复合类型定义。

instruction(action="list")

获取指令列表，按关键字过滤，返回标准指令和扩展指令。

参数	类型	必填	说明
action	str	必填	固定 "list"
keyword	str	必填	关键字过滤（匹配 name、desc、location），支持逗号分隔批量查询
limit	int	可选	返回数量上限，默认 10。批量查询时每个关键字最多 3 条

instruction(action="types")

查询 RPA 复合类型定义。

参数	类型	必填	说明
action	str	必填	固定 "types"
location	str	可选	指定类型名，不传返回全量

2. project

项目操作工具。管理 RPA 项目的创建、查询和更新。

project(action="info")

获取当前打开项目的信息。

参数	类型	必填	说明
action	str	必填	固定 "info"

project(action="create")

创建新项目。

参数	类型	必填	说明
action	str	必填	固定 "create"
app_name	str	必填	项目名称
app_path	str	必填	项目路径
description	str	可选	项目描述

project(action="update")

更新项目信息。

参数	类型	必填	说明
action	str	必填	固定 "update"
updates	dict	必填	要更新的字段

3. workflow

工作流管理工具。管理工作流的增删改查和打开操作。

workflow(action="list")

获取所有工作流列表。

参数	类型	必填	说明
action	str	必填	固定 "list"

workflow(action="create")

创建新工作流。

参数	类型	必填	说明
action	str	必填	固定 "create"
filename	str	可选	工作流文件名（仅允许字母和数字），不传自动生成

workflow(action="delete")

删除工作流。

参数	类型	必填	说明
action	str	必填	固定 "delete"
seq_tag	str	必填	流程 SeqTag 标识

workflow(action="info")

获取工作流详情。

参数	类型	必填	说明
action	str	必填	固定 "info"
seq_tag	str	必填	流程 SeqTag 标识

workflow(action="update")

更新工作流（整体更新 nodes 和 edges）。

参数	类型	必填	说明
action	str	必填	固定 "update"
flow	dict	必填	流程对象，包含 Seq、nodes、edges

workflow(action="open")

在客户端中打开指定流程。

参数	类型	必填	说明
action	str	必填	固定 "open"
seq_tag	str	必填	流程 SeqTag 标识

4. workflow_node 支持批量

工作流节点操作工具。支持批量模式：传 items 数组，每项可包含下列字段，未提供的继承外层同名参数。批量执行时每项之间间隔 50ms。

workflow_node(action="add")

向工作流中添加一个节点。

参数	类型	必填	说明
action	str	必填	固定 "add"
seq_tag	str	必填	流程 SeqTag 标识
location	str	必填	指令唯一标识（通过 instruction.list 获取）

workflow_node(action="update")

更新节点的参数或位置。

参数	类型	必填	说明
action	str	必填	固定 "update"
seq_tag	str	必填	流程 SeqTag 标识
node_id	str	必填	节点 ID
updates	dict	必填	要更新的字段，可包含 data (dict) 和 position (dict {x, y})

workflow_node(action="delete")

删除节点。

参数	类型	必填	说明
action	str	必填	固定 "delete"
seq_tag	str	必填	流程 SeqTag 标识
node_id	str	必填	节点 ID

workflow_node(action="info")

获取节点详情。

参数	类型	必填	说明
action	str	必填	固定 "info"
seq_tag	str	必填	流程 SeqTag 标识
node_id	str	必填	节点 ID

workflow_node(action="enable")

启用或禁用节点。

参数	类型	必填	说明
action	str	必填	固定 "enable"
seq_tag	str	必填	流程 SeqTag 标识
node_id	str	可选	节点 ID（与 node_ids 二选一）
node_ids	list[str]	可选	多个节点 ID（与 node_id 二选一）
enabled	bool	必填	是否启用

workflow_node(action="available_vars")

查询节点可访问的上游变量。

参数	类型	必填	说明
action	str	必填	固定 "available_vars"
seq_tag	str	必填	流程 SeqTag 标识
node_id	str	必填	节点 ID

5. workflow_edge 支持批量

工作流连线操作工具。支持批量模式：传 items 数组，每项可包含下列字段，未提供的继承外层同名参数。批量执行时每项之间间隔 50ms。

workflow_edge(action="add")

添加节点间的连线。

参数	类型	必填	说明
action	str	必填	固定 "add"
seq_tag	str	必填	流程 SeqTag 标识
source	str	必填	源节点 ID
target	str	必填	目标节点 ID
source_handle	str	必填	源节点句柄
target_handle	str	必填	目标节点句柄

workflow_edge(action="delete")

删除连线。

参数	类型	必填	说明
action	str	必填	固定 "delete"
seq_tag	str	必填	流程 SeqTag 标识
edge_id	str	必填	连线 ID

workflow_edge(action="info")

获取连线详情。

参数	类型	必填	说明
action	str	必填	固定 "info"
seq_tag	str	必填	流程 SeqTag 标识
edge_id	str	必填	连线 ID

6. main_process_var

主流程参数操作工具。管理主流程的输入/输出参数。

main_process_var(action="list")

获取所有主流程参数列表。

参数	类型	必填	说明
action	str	必填	固定 "list"

main_process_var(action="info")

获取指定参数详情。

参数	类型	必填	说明
action	str	必填	固定 "info"
vartag	str	必填	参数唯一标识

main_process_var(action="add")

添加主流程参数。

参数	类型	必填	说明
action	str	必填	固定 "add"
var_direction	str	可选	参数方向："input" 或 "output"，默认 "input"
var_name	str	可选	参数名称，不提供则自动生成
data_type	str	可选	数据类型：str, number, bool, list, date, datetime, time, daterange, month, monthrange, FilePath, DirectoryPath, account
var_desc	str	可选	参数描述
input_props	dict	可选	组件属性 {placeholder, required, uiComponent}

main_process_var(action="update")

更新主流程参数。

参数	类型	必填	说明
action	str	必填	固定 "update"
vartag	str	必填	参数唯一标识
updates	dict	必填	可包含 varname, dataType, vardesc

main_process_var(action="delete")

删除主流程参数。

参数	类型	必填	说明
action	str	必填	固定 "delete"
vartag	str	必填	参数唯一标识

7. sub_process_var

子流程参数操作工具。管理子流程的输入/输出参数。

sub_process_var(action="list")

获取子流程所有参数列表。

参数	类型	必填	说明
action	str	必填	固定 "list"
seq_tag	str	必填	子流程 SeqTag 标识

sub_process_var(action="info")

获取指定参数详情。

参数	类型	必填	说明
action	str	必填	固定 "info"
vartag	str	必填	参数唯一标识

sub_process_var(action="add")

添加子流程参数。

参数	类型	必填	说明
action	str	必填	固定 "add"
seq_tag	str	必填	子流程 SeqTag 标识
var_direction	str	可选	参数方向："input" 或 "output"，默认 "input"
var_name	str	可选	参数名称，不提供则自动生成
data_type	str	可选	数据类型：str, number, bool, list, date, datetime, time, daterange, month, monthrange, FilePath, DirectoryPath, account, any
var_desc	str	可选	参数描述

sub_process_var(action="update")

更新子流程参数。

参数	类型	必填	说明
action	str	必填	固定 "update"
vartag	str	必填	参数唯一标识
updates	dict	必填	可包含 varname, dataType, vardesc, vardirection

sub_process_var(action="delete")

删除子流程参数。注意：会同步删除所有引用该子流程的 Subflow 节点中的参数配置。

参数	类型	必填	说明
action	str	必填	固定 "delete"
vartag	str	必填	参数唯一标识

8. global_var

全局变量操作工具。管理项目级别的全局变量。

global_var(action="list")

获取所有全局变量列表。

参数	类型	必填	说明
action	str	必填	固定 "list"

global_var(action="info")

获取指定全局变量详情。

参数	类型	必填	说明
action	str	必填	固定 "info"
vartag	str	必填	变量唯一标识

global_var(action="add")

添加全局变量。

参数	类型	必填	说明
action	str	必填	固定 "add"
var_name	str	可选	变量名称（仅字母和数字），不提供则自动生成
data_type	str	可选	数据类型：str, number, bool, list, date, datetime, time, daterange, month, monthrange, FilePath, DirectoryPath, account, any
var_desc	str	可选	变量描述
input_props	dict	可选	组件属性 {placeholder, required, uiComponent}

global_var(action="update")

更新全局变量。

参数	类型	必填	说明
action	str	必填	固定 "update"
vartag	str	必填	变量唯一标识
updates	dict	必填	可包含 varname, dataType, vardesc, inputProps

global_var(action="delete")

删除全局变量。

参数	类型	必填	说明
action	str	必填	固定 "delete"
vartag	str	必填	变量唯一标识

9. get_parameter_rules

获取工作流参数编辑规则文档。返回主流程参数和子流程参数的详细编辑规则说明（Markdown 格式）。在使用参数相关工具前，建议先调用此工具了解规则。

get_parameter_rules()

无需参数，直接调用即可。

参数	类型	必填	说明
无参数

10. element

元素操作工具。管理 RPA 页面元素的增删改查。

element(action="list")

获取元素列表。

参数	类型	必填	说明
action	str	必填	固定 "list"

element(action="info")

获取指定元素详情。

参数	类型	必填	说明
action	str	必填	固定 "info"
element_id	str	必填	元素 ID

element(action="add")

添加元素。

参数	类型	必填	说明
action	str	必填	固定 "add"
element_info	dict	必填	元素信息

element(action="update")

更新元素。

参数	类型	必填	说明
action	str	必填	固定 "update"
element_id	str	必填	元素 ID
updates	dict	必填	要更新的字段

element(action="delete")

删除元素。

参数	类型	必填	说明
action	str	必填	固定 "delete"
element_id	str	必填	元素 ID

11. run

运行相关操作工具。同步等待模式，运行指令会等待任务完成后返回结果。

run(action="project")

运行整个项目。

参数	类型	必填	说明
action	str	必填	固定 "project"
runtime_args	dict	可选	运行时参数
main_flow_seq_tag	str	可选	指定主流程

run(action="flow")

运行指定流程。

参数	类型	必填	说明
action	str	必填	固定 "flow"
seq_tag	str	必填	流程 SeqTag 标识
runtime_args	dict	可选	运行时参数

run(action="node")

运行单个节点。

参数	类型	必填	说明
action	str	必填	固定 "node"
seq_tag	str	必填	流程 SeqTag 标识
node_id	str	必填	节点 ID

run(action="node_from")

从指定节点开始运行（包含该节点及后续节点）。

参数	类型	必填	说明
action	str	必填	固定 "node_from"
seq_tag	str	必填	流程 SeqTag 标识
node_id	str	必填	起始节点 ID

run(action="stop")

停止当前运行。

参数	类型	必填	说明
action	str	必填	固定 "stop"

run(action="status")

查询当前运行状态。

参数	类型	必填	说明
action	str	必填	固定 "status"

run(action="log")

获取运行日志。

参数	类型	必填	说明
action	str	必填	固定 "log"

run(action="compile")

编译项目。

参数	类型	必填	说明
action	str	必填	固定 "compile"
main_flow_seq_tag	str	可选	指定主流程

run(action="checklist")

获取检查清单。

参数	类型	必填	说明
action	str	必填	固定 "checklist"
seq_tag	str	可选	流程 SeqTag，不传则检查所有流程