Skip to main content
Version: 5.1.0

toggle_incr_sync

所属分类：轻量操作 · Tool 名称：toggle_incr_sync

功能说明​

启动或停止指定管道的增量（实时）同步通道。增量同步是长驻运行（基于 Flink，部署在 K8s 上）的进程，启动 / 停止均为异步操作，操作受理后需通过 get_incr_sync_status 确认最终状态。

操作类 Tool

本 Tool 会真实改变增量同步通道的运行状态。停止增量同步会中断实时数据流，重启后按保存点 / 起始位点恢复。建议在 Agent 客户端开启 Tool 调用确认机制，由用户二次确认后执行。

输入参数​

参数类型必填说明
pipelinestring是管道名称（可通过 list_pipeline 获取）
actionstring是操作类型，枚举值：start（启动）/ stop（停止）

输出结果​

返回 TIS 标准信封结构（详见 总览 - 通用返回约定）：

字段类型说明
successboolean操作请求是否受理成功
errormsgstring[]错误信息列表。出现非空 errormsg 时调用端应立即终止后续执行并告知用户
msgstring[]操作结果描述，如「已停止管道 mysql2doris_orders 的增量同步」「增量同步启动请求已提交」

返回示例​

{
  "success": true,
  "errormsg": [],
  "msg": ["增量同步启动请求已提交，管道: mysql2doris_orders。请通过 get_incr_sync_status 查询启动结果。"]
}

错误返回​

情况表现
pipeline 为空MCP 层 isError: true，内容为参数错误描述文本
action 为空或不是 start / stopMCP 层 isError: true，内容为参数错误描述文本
服务端内部异常MCP 层 isError: true，内容为通用错误提示文本

注意点​

  1. 异步生效：启动 / 停止请求受理后，增量实例的状态变化需要一定时间（启动通常需数十秒完成 Flink 作业拉起）。请间隔数秒后调用 get_incr_sync_status 确认 state 变为 RUNNING / STOPPED。
  2. 前置条件：目标管道必须已配置增量同步通道（可先通过 get_incr_sync_status 确认 configured 与 state），未配置增量通道的管道请先在 TIS 控制台完成增量通道配置。
  3. 管道是否具备增量同步能力（supportIncrSynchronize）可通过 list_pipeline 查询。

典型用法​

在 Hermes 中的提问示例：

把 mysql2doris_orders 的实时同步停一下
使用 toggle_incr_sync 工具：启动 mysql2doris_orders 的增量同步，启动后帮我确认状态