MCP 工具参考
由 scripts/gen-mcp-docs.sh 从服务器的 tools/list 生成。总共 45 个工具;仅当服务器与 --allow-write 一起运行时,才会注册标记为 写入 的工具。启用写入之前,请参阅应用程序和代理的安全操作。
alarms_events(只读)
“alarms_events(只读)”标题的链接列出历史警报事件,可以选择按以下条件过滤规则/类型/级别/关键字
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
event_type |
字符串/空值 | 否 | 按事件类型过滤:“触发”(引发警报)或“恢复”(清除警报) |
keyword |
字符串/空值 | 否 | 跨规则名称、通道、点进行关键字搜索 |
level |
整数/空值 | 否 | 按警告级别过滤(1=低、2=中、3=高) |
page |
整数 | 否 | 页码(从1开始) |
rule |
整数/空值 | 否 | 按警报规则 ID 过滤 |
size |
整数 | 否 | 页面大小 |
alarms_get(只读)
“alarms_get(只读)”标题的链接通过以下方式获取特定的活动警报ID
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
id |
整数 | 是 | 警报 ID |
alarms_list(只读)
“alarms_list(只读)”标题的链接列出活动状态警报,可选择按通道/级别/关键字过滤
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
channel |
整数/空值 | 否 | 按通道 ID 过滤 |
keyword |
字符串/空值 | 否 | 跨规则名称、通道、点进行关键字搜索 |
level |
整数/空值 | 否 | 按警告级别过滤(1=低、2=中、3=高) |
page |
整数 | 否 | 页码(从 1 开始) |
size |
整数 | 否 | 页面大小 |
alarms_resolve(写入)
“alarms_resolve(写入)”标题的链接通过经过身份验证、明确确认和审核的警报解决应用程序命令解决活动警报。此高风险命令会清除操作员可见的警报指示;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认清除当前活动警报 |
id |
整数 | 是 | 活动警报 ID |
alarms_rule_create(写入)
“alarms_rule_create(写入)”标题的链接通过经过身份验证、明确确认和审核的警报策略应用命令创建警报规则。 body 必须与警报 CreateRuleRequest 匹配。这是一个高风险的警报策略突变;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
body |
- | 是 | 完整的 CreateRuleRequest 正文:service_type、channel_id、data_type、point_id、rule_name、operator、value 和(可选) warning_level,enabled,description |
confirmed |
布尔值 | 是 | 显式确认此高风险警报策略变更。 |
alarms_rule_delete(写入)
“alarms_rule_delete(写入)”标题的链接通过身份验证、显式确认和审核删除警报规则报警策略应用命令。这是一个高风险的警报策略突变;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认此高风险警报策略变更 |
id |
整数 | 是 | 警报规则 ID |
alarms_rule_disable(写入)
“alarms_rule_disable(写入)”标题的链接通过经过身份验证、显式确认和审核的警报策略应用命令禁用警报规则。这是一个高风险的警报策略突变;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认此高风险警报策略突变。 |
id |
整数 | 是 | 警报规则 ID |
alarms_rule_enable(写入)
“alarms_rule_enable(写入)”标题的链接通过经过身份验证、明确确认和审核的警报策略应用程序启用警报规则命令。这是一个高风险的警报策略突变;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认此高风险警报策略变更 |
id |
整数 | 是 | 报警规则ID |
alarms_rule_get(只读)
“alarms_rule_get(只读)”标题的链接获取特定报警规则ID
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
id |
整数 | 是 | 报警规则ID |
alarms_rule_update(写入)
“alarms_rule_update(写入)”标题的链接通过经过身份验证、明确确认和审核的警报策略应用命令更新警报规则。 body 是部分 UpdateRuleRequest。这是一个高风险的警报策略突变;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
body |
- | 是 | 部分 UpdateRuleRequest 正文;仅提交需要更改的字段 |
confirmed |
布尔值 | 是 | 明确确认此高风险警报策略变更。 |
id |
整数 | 是 | 警报规则 ID |
alarms_rules_list(只读)
“alarms_rules_list(只读)”标题的链接列出警报规则,可选择按以下条件过滤channel/enabled/level/keyword
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
channel |
整数/空值 | 否 | 按通道 ID 过滤 |
enabled |
布尔值/空值 | 否 | 按启用或禁用状态过滤 |
keyword |
字符串/空值 | 否 | 跨规则名称、通道和点位进行关键字搜索 |
level |
整数/空值 | 否 | 按警告级别过滤(1=低、2=中、3=高) |
page |
整数 | 否 | 页码(基于 1) |
size |
整数 | 否 | 页面大小 |
alarms_stats(只读)
“alarms_stats(只读)”标题的链接获取聚合警报统计信息
channels_create(写入)
“channels_create(写入)”标题的链接通过经过身份验证、显式确认和审核的 io.channel.manage 应用程序命令创建通信通道。这是一个高风险、非幂等的委托变更;启用状态默认为 false。成功结果可能会报告降级的运行时投影或不完整的完成审核:检查 request_id、resulting_revision 和 reconciliation_required。客户端不得自动重试。
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认此高风险通道变更 |
description |
字符串/空值 | 否 | 可选描述 |
enabled |
布尔值 | 否 | 通道创建后是否立即启用;默认为 false |
id |
整数/空值 | 否 | 显式通道 ID;省略时自动分配 |
name |
字符串 | 是 | 通道名称 |
parameters |
- | 是 | 特定于协议的连接参数(结构取决于 protocol) |
protocol |
字符串 | 是 | 协议标识符,例如“modbus”、“iec104” |
channels_delete(写入)
“channels_delete(写入)”标题的链接通过经过身份验证、明确确认和审核的 io.channel.manage 应用程序命令删除通信通道。操作路径引用会导致冲突,并且永远不会静默级联。这是一个高风险、非幂等的委托突变;成功可能会报告降级的运行时预测或不完整的完成审核。检查 request_id、resulting_revision 和 reconciliation_required。客户端不得自动重试。
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
channel_id |
整数 | 是 | 通道ID |
confirmed |
布尔值 | 是 | 明确确认此高风险通道变更。 |
expected_revision |
整数 | 是 | 最新读取的通道期望状态修订号(最小值为 1),用于比较并交换 |
channels_disable(写入)
“channels_disable(写入)”标题的链接通过经过身份验证、显式确认和审核的 io.channel.manage 应用程序命令禁用通信通道。这是一个高风险、非幂等的生命周期突变;接受降级的运行时预测并需要协调。检查 request_id、resulting_revision 和 reconciliation_required。客户端不得自动重试,包括完成审核未完成时。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
channel_id |
整数 | 是 | 通道 ID |
confirmed |
布尔值 | 是 | 明确确认此高风险通道变更。 |
expected_revision |
整数 | 是 | 最新读取的通道期望状态修订号(最小值为 1),用于比较并交换 |
channels_enable(写入)
“channels_enable(写入)”标题的链接通过经过身份验证、显式确认和审核的 io.channel.manage 应用程序命令启用通信通道。这是一个高风险、非幂等的生命周期突变;激活待定或降级被接受并需要协调,而不是连接证明。检查 request_id、resulting_revision 和 reconciliation_required。客户端不得自动重试,包括完成审核未完成时。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
channel_id |
整数 | 是 | 通道 ID |
confirmed |
布尔值 | 是 | 明确确认此高风险通道变更。 |
expected_revision |
整数 | 是 | 最新读取的通道期望状态修订号(最小值为 1),用于比较并交换 |
channels_list(只读)
“channels_list(只读)”标题的链接列出所有已配置的通信通道
channels_mappings(只读)
“channels_mappings(只读)”标题的链接显示通道的点到实例映射
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
channel_id |
整数 | 是 | 通道 ID |
channels_points (只读)
“channels_points (只读)”标题的链接列出通道上的点,可选择按类型 (T/S/C/A) 过滤
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
channel_id |
整数 | 是 | 通道ID |
point_type |
字符串/空值 | 否 | 可选点类型过滤器:T \ |
channels_points_mapping(只读)
“channels_points_mapping(只读)”标题的链接显示实例映射单点
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
channel_id |
整数 | 是 | 通道ID |
point_id |
整数 | 是 | 点 ID |
point_type |
字符串 | 是 | 点类型:T \ |
channels_reconcile(写入)
“channels_reconcile(写入)”标题的链接通过经过身份验证、显式确认和审核的 io.channel.reconcile 应用程序命令从权威的所需状态协调每个通道运行时。这是一个高风险、非幂等的操作,可以重新连接协议会话。检查 request_id、每个已清理的项目、degraded_count、reconciliation_required 和completion_audit。客户端不得自动重试,包括运行时收敛或终端审核未完成时。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认此高风险、非幂等的运行时协调操作。 |
channels_status(只读)
“channels_status(只读)”标题的链接获取特定通道的连接状态
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
channel_id |
整数 | 是 | 通道ID |
channels_unmapped_points(只读)
“channels_unmapped_points(只读)”标题的链接列出通道上没有协议地址映射的点(未连接到设备寄存器的点;实例路由是一个单独的关注)
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
channel_id |
整数 | 是 | 频道 ID |
channels_update(写入)
“channels_update(写入)”标题的链接通过经过身份验证、明确确认和审核的 io.channel.manage 应用程序命令更新通信通道。这是一个高风险、非幂等的委托突变;需要来自最新通道读取的预期修订作为比较和设置保护。成功可能会报告降级的运行时预测或不完整的完成审核:检查 request_id、resulting_revision 和 reconciliation_required。客户端不得自动重试。
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
body |
- | 是 | 部分更新正文 - 仅存在字段已更改 |
channel_id |
整数 | 是 | 通道 ID |
confirmed |
布尔值 | 是 | 明确确认此高风险通道变更 |
expected_revision |
整数 | 是 | 从最新读取的通道中所需的状态比较和设置修订(最小 1) |
history_latest(只读)
“history_latest(只读)”标题的链接获取某个值的最新历史值点
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
point_id |
字符串 | 是 | 其中的点ID系列 |
series_key |
字符串 | 是 | 标识系列的逻辑键,例如“io:1001:T” |
history_query(只读)
“history_query(只读)”标题的链接查询指定时间范围内某个点的历史时间序列数据
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
from |
字符串/空值 | 否 | 时间范围的开始(RFC3339);省略时无下限 |
page |
整数 | 否 | 页码(从 1 开始) |
point_id |
字符串 | 是 | 该范围内的点 ID系列 |
series_key |
字符串 | 是 | 标识系列的逻辑键,例如“io:1001:T” |
size |
整数 | 否 | 页面大小 |
to |
字符串/空值 | 否 | 时间范围的结束(RFC3339);省略时表示当前时间 |
models_instances(只读)
“models_instances(只读)”标题的链接列出设备实例,并可按产品类型过滤
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
product |
字符串/空值 | 否 | 按产品类型过滤,例如“ESS”或“电池” |
models_instances_action(写入)
“models_instances_action(写入)”标题的链接通过经过身份验证、明确确认和审核的应用命令提交控制操作。成功意味着本地命令平面接受了它,而不是物理设备执行了它。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 显式确认此高风险设备命令。 |
instance_id |
整数 | 是 | 实例 ID |
point_id |
字符串 | 是 | 编码为字符串的数字操作点 ID(例如 "1") |
value |
数字 | 是 | 要写入的值 |
models_products(只读)
“models_products(只读)”标题的链接列出可用的产品类型
net
“net”标题的链接net_cert_info (只读)
“net_cert_info (只读)”标题的链接显示已安装的 TLS 证书信息(存在 ca_cert/client_cert/client_key 中的哪一个)
net_mqtt_config_get(只读)
“net_mqtt_config_get(只读)”标题的链接显示当前上行链路配置(MQTT 代理、TLS 设置)
net_mqtt_status(只读)
“net_mqtt_status(只读)”标题的链接显示MQTT 连接状态(已连接/已断开连接、代理地址)
routing_action_delete(写入)
“routing_action_delete(写入)”标题的链接通过经过身份验证、明确确认和审核的应用程序命令删除操作路由。这是一种高风险的物理拓扑变更;成功响应不会执行设备命令,客户端不得自动重试不完整的审核或发布结果。
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
action_point_id |
整数 | 是 | 实例模型内的逻辑操作点 ID。 |
confirmed |
布尔值 | 是 | 明确确认此高风险物理拓扑更改。 |
instance_id |
整数 | 是 | 拥有该逻辑操作点的实例。 |
routing_action_set_enabled(写入)
“routing_action_set_enabled(写入)”标题的链接通过经过身份验证、显式确认和审核的应用程序命令启用或禁用操作路由。这是一种高风险的物理拓扑变更;成功响应不会执行设备命令,客户端不得自动重试不完整的审核或发布结果。
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
action_point_id |
整数 | 是 | 实例内的逻辑操作点 ID |
confirmed |
布尔值 | 是 | 明确确认此高风险物理拓扑更改。 |
enabled |
布尔值 | 是 | 路由是否参与命令调度。 |
instance_id |
整数 | 是 | 拥有逻辑操作点的实例。 |
routing_action_upsert(写入)
“routing_action_upsert(写入)”标题的链接通过经过身份验证、显式确认和审核的应用程序命令更改操作路由的物理 C/A 目标。这是一种高风险的拓扑变更;成功响应不会执行设备命令,客户端不得自动重试不完整的审核或发布结果。
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
action_point_id |
整数 | 是 | 实例模型内的逻辑操作点 ID。 |
channel_id |
整数 | 是 | 物理目标通道。 |
channel_point_id |
整数 | 是 | 目标通道中的物理点 ID。 |
channel_type |
字符串 | 是 | 物理命令点类型:C 或 A。 |
confirmed |
布尔值 | 是 | 明确确认此高风险物理拓扑变更 |
enabled |
布尔值 | 否 | 新路由是否参与命令调度。 |
instance_id |
整数 | 是 | 拥有该逻辑操作点的实例 |
routing_list(只读)
“routing_list(只读)”标题的链接列出所有 M2C/C2M 路由条目
rules_create(写入)
“rules_create(写入)”标题的链接通过经过身份验证、显式确认和审核的规则管理应用程序命令创建一个禁用的业务规则空壳。这是一个高风险的规则策略变更;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认此高风险规则策略变更 |
description |
字符串/空值 | 否 | 可选描述 |
name |
字符串 | 是 | 规则名称 |
rules_delete(写入)
“rules_delete(写入)”标题的链接通过经过身份验证、明确确认和审核的规则管理应用程序命令删除业务规则。这是一个高风险的规则政策突变;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认此高风险规则策略变更。 |
rule_id |
整数 | 是 | 规则 ID |
rules_disable(写入)
“rules_disable(写入)”标题的链接通过经过身份验证、明确确认和审核的规则管理应用程序命令禁用业务规则。这是一个高风险的规则政策突变;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认此高风险规则策略变更 |
rule_id |
整数 | 是 | 规则 ID |
rules_enable(写入)
“rules_enable(写入)”标题的链接通过经过身份验证、显式确认和审核的规则管理应用程序命令启用业务规则。这是一个高风险的规则政策突变;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认此高风险规则策略变更 |
rule_id |
整数 | 是 | 规则 ID |
rules_execute(写入)
“rules_execute(写入)”标题的链接立即通过经过身份验证、显式确认和审核的应用程序命令执行规则。选定的设备操作被本地命令平面接受;成功并不证明物理设备完成。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
confirmed |
布尔值 | 是 | 明确确认该规则可以调度真实设备命令。 |
rule_id |
整数 | 是 | 规则 ID |
rules_get(只读)
“rules_get(只读)”标题的链接通过以下方式获取特定业务规则ID
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
rule_id |
整数 | 是 | 规则ID |
rules_list(只读)
“rules_list(只读)”标题的链接列出全部业务规则
rules_update(写入)
“rules_update(写入)”标题的链接通过经过身份验证、明确确认和审核的规则管理应用程序命令更新业务规则。 body 是部分规则更新对象。这是一个高风险的规则政策突变;客户端不得自动重试不完整的审核结果。
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
body |
- | 是 | 部分更新正文 - 仅存在字段已更改 |
confirmed |
布尔值 | 是 | 明确确认此高风险规则策略变更。 |
rule_id |
整数 | 是 | 规则 ID |
templates_list(只读)
“templates_list(只读)”标题的链接列出通道配置模板,可以选择按以下条件过滤协议
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
protocol |
字符串/空值 | 否 | 按协议过滤,例如 "modbus" |