MCP Tools Reference

MCP Tools Reference

Generated by scripts/gen-mcp-docs.sh from the server’s tools/list. 45 tools total; tools marked WRITE are registered only when the server runs with --allow-write. See Safe Operations for Applications and Agents before enabling writes.

alarms

alarms_events (read-only)

List historical alarm events, optionally filtered by rule/type/level/keyword

Parameter	Type	Required	Description
event_type	string/null	no	Filter by event type: “trigger” (alarm raised) or “recovery” (alarm cleared)
keyword	string/null	no	Keyword search across rule name, channel, point
level	integer/null	no	Filter by warning level (1=low, 2=medium, 3=high)
page	integer	no	Page number (1-based)
rule	integer/null	no	Filter by alarm rule ID
size	integer	no	Page size

alarms_get (read-only)

Get a specific active alert by ID

Parameter	Type	Required	Description
id	integer	yes	Alert ID

alarms_list (read-only)

List active alarms, optionally filtered by channel/level/keyword

Parameter	Type	Required	Description
channel	integer/null	no	Filter by channel ID
keyword	string/null	no	Keyword search across rule name, channel, point
level	integer/null	no	Filter by warning level (1=low, 2=medium, 3=high)
page	integer	no	Page number (1-based)
size	integer	no	Page size

alarms_resolve (WRITE)

Resolve an active alert through the authenticated, explicitly confirmed, and audited alert-resolution application command. This high-risk command clears an operator-visible alert indication; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms that the active alert indication may be cleared.
id	integer	yes	Active alert ID

alarms_rule_create (WRITE)

Create an alarm rule through the authenticated, explicitly confirmed, and audited alarm-policy application command. body must match the alarm CreateRuleRequest. This is a high-risk alarm-policy mutation; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
body	-	yes	Full CreateRuleRequest body: service_type, channel_id, data_type, point_id, rule_name, operator, value, and optionally warning_level, enabled, description
confirmed	boolean	yes	Explicitly confirms this high-risk alarm-policy mutation.

alarms_rule_delete (WRITE)

Delete an alarm rule through the authenticated, explicitly confirmed, and audited alarm-policy application command. This is a high-risk alarm-policy mutation; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms this high-risk alarm-policy mutation.
id	integer	yes	Alarm rule ID

alarms_rule_disable (WRITE)

Disable an alarm rule through the authenticated, explicitly confirmed, and audited alarm-policy application command. This is a high-risk alarm-policy mutation; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms this high-risk alarm-policy mutation.
id	integer	yes	Alarm rule ID

alarms_rule_enable (WRITE)

Enable an alarm rule through the authenticated, explicitly confirmed, and audited alarm-policy application command. This is a high-risk alarm-policy mutation; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms this high-risk alarm-policy mutation.
id	integer	yes	Alarm rule ID

alarms_rule_get (read-only)

Get a specific alarm rule by ID

Parameter	Type	Required	Description
id	integer	yes	Alarm rule ID

alarms_rule_update (WRITE)

Update an alarm rule through the authenticated, explicitly confirmed, and audited alarm-policy application command. body is a partial UpdateRuleRequest. This is a high-risk alarm-policy mutation; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
body	-	yes	Partial UpdateRuleRequest body – only fields present are changed
confirmed	boolean	yes	Explicitly confirms this high-risk alarm-policy mutation.
id	integer	yes	Alarm rule ID

alarms_rules_list (read-only)

List alarm rules, optionally filtered by channel/enabled/level/keyword

Parameter	Type	Required	Description
channel	integer/null	no	Filter by channel ID
enabled	boolean/null	no	Filter by enabled/disabled state
keyword	string/null	no	Keyword search across rule name, channel, point
level	integer/null	no	Filter by warning level (1=low, 2=medium, 3=high)
page	integer	no	Page number (1-based)
size	integer	no	Page size

alarms_stats (read-only)

Get aggregate alarm statistics

channels

channels_create (WRITE)

Create a communication channel through the authenticated, explicitly confirmed, and audited io.channel.manage application command. This is a high-risk, non-idempotent commissioning mutation; enabled defaults to false. Success may report a degraded runtime projection or incomplete completion audit: inspect request_id, resulting_revision, and reconciliation_required. Clients must not automatically retry.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms this high-risk channel commissioning mutation.
description	string/null	no	Optional description
enabled	boolean	no	Whether the channel starts enabled. Defaults to false so creation is inert.
id	integer/null	no	Explicit channel ID; omit to auto-assign
name	string	yes	Channel name
parameters	-	yes	Protocol-specific connection parameters (shape depends on protocol)
protocol	string	yes	Protocol identifier, e.g. “modbus”, “iec104”

channels_delete (WRITE)

Delete a communication channel through the authenticated, explicitly confirmed, and audited io.channel.manage application command. Action-route references cause a conflict and are never silently cascaded. This is a high-risk, non-idempotent commissioning mutation; success may report a degraded runtime projection or incomplete completion audit. Inspect request_id, resulting_revision, and reconciliation_required. Clients must not automatically retry.

Parameter	Type	Required	Description
channel_id	integer	yes	Channel ID
confirmed	boolean	yes	Explicitly confirms this high-risk channel commissioning mutation.
expected_revision	integer	yes	Required desired-state compare-and-set revision from the latest channel read (minimum 1)

channels_disable (WRITE)

Disable a communication channel through the authenticated, explicitly confirmed, and audited io.channel.manage application command. This is a high-risk, non-idempotent lifecycle mutation; a degraded runtime projection is accepted and requires reconciliation. Inspect request_id, resulting_revision, and reconciliation_required. Clients must not automatically retry, including when completion audit is incomplete.

Parameter	Type	Required	Description
channel_id	integer	yes	Channel ID
confirmed	boolean	yes	Explicitly confirms this high-risk channel commissioning mutation.
expected_revision	integer	yes	Required desired-state compare-and-set revision from the latest channel read (minimum 1)

channels_enable (WRITE)

Enable a communication channel through the authenticated, explicitly confirmed, and audited io.channel.manage application command. This is a high-risk, non-idempotent lifecycle mutation; activation-pending or degraded is accepted and requires reconciliation, not proof of connectivity. Inspect request_id, resulting_revision, and reconciliation_required. Clients must not automatically retry, including when completion audit is incomplete.

Parameter	Type	Required	Description
channel_id	integer	yes	Channel ID
confirmed	boolean	yes	Explicitly confirms this high-risk channel commissioning mutation.
expected_revision	integer	yes	Required desired-state compare-and-set revision from the latest channel read (minimum 1)

channels_list (read-only)

List all configured communication channels

channels_mappings (read-only)

Show a channel’s point-to-instance mappings

Parameter	Type	Required	Description
channel_id	integer	yes	Channel ID

channels_points (read-only)

List points on a channel, optionally filtered by type (T/S/C/A)

Parameter	Type	Required	Description
channel_id	integer	yes	Channel ID
point_type	string/null	no	Optional point-type filter: T | S | C | A

channels_points_mapping (read-only)

Show the instance mapping for a single point

Parameter	Type	Required	Description
channel_id	integer	yes	Channel ID
point_id	integer	yes	Point ID
point_type	string	yes	Point type: T | S | C | A

channels_reconcile (WRITE)

Reconcile every channel runtime from authoritative desired state through the authenticated, explicitly confirmed, and audited io.channel.reconcile application command. This is a high-risk, non-idempotent operation that can reconnect protocol sessions. Inspect request_id, each sanitized item, degraded_count, reconciliation_required, and completion_audit. Clients must not automatically retry, including when runtime convergence or terminal audit remains incomplete.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms this high-risk, non-idempotent runtime reconciliation.

channels_status (read-only)

Get the connection status of a specific channel

Parameter	Type	Required	Description
channel_id	integer	yes	Channel ID

channels_unmapped_points (read-only)

List points on a channel that have no protocol address mapping (points not wired to a device register; instance routing is a separate concern)

Parameter	Type	Required	Description
channel_id	integer	yes	Channel ID

channels_update (WRITE)

Update a communication channel through the authenticated, explicitly confirmed, and audited io.channel.manage application command. This is a high-risk, non-idempotent commissioning mutation; expected_revision from the latest channel read is required as a compare-and-set guard. Success may report a degraded runtime projection or incomplete completion audit: inspect request_id, resulting_revision, and reconciliation_required. Clients must not automatically retry.

Parameter	Type	Required	Description
body	-	yes	Partial update body – only fields present are changed
channel_id	integer	yes	Channel ID
confirmed	boolean	yes	Explicitly confirms this high-risk channel commissioning mutation.
expected_revision	integer	yes	Required desired-state compare-and-set revision from the latest channel read (minimum 1)

history

history_latest (read-only)

Get the latest historical value for a point

Parameter	Type	Required	Description
point_id	string	yes	Point ID within that series
series_key	string	yes	Logical key identifying the series, e.g. “io:1001:T”

history_query (read-only)

Query historical time-series data for a point over a time range

Parameter	Type	Required	Description
from	string/null	no	Start of the time range (RFC3339); omit for no lower bound
page	integer	no	Page number (1-based)
point_id	string	yes	Point ID within that series
series_key	string	yes	Logical key identifying the series, e.g. “io:1001:T”
size	integer	no	Page size
to	string/null	no	End of the time range (RFC3339); omit for “now”

models

models_instances (read-only)

List device instances, optionally filtered by product type

Parameter	Type	Required	Description
product	string/null	no	Filter by product type, e.g. “ESS”, “Battery”

models_instances_action (WRITE)

Submit a control action through the authenticated, explicitly confirmed, and audited application command. Success means the local command plane accepted it, not that the physical device executed it.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms this high-risk device command.
instance_id	integer	yes	Instance ID
point_id	string	yes	Numeric action point ID encoded as a string (for example, “1”)
value	number	yes	Value to write

models_products (read-only)

List available product types

net

net_cert_info (read-only)

Show installed TLS certificate info (which of ca_cert/client_cert/client_key are present)

net_mqtt_config_get (read-only)

Show the current uplink configuration (MQTT broker, TLS settings)

net_mqtt_status (read-only)

Show MQTT connection status (connected/disconnected, broker address)

routing

routing_action_delete (WRITE)

Delete an action route through the authenticated, explicitly confirmed, and audited application command. This is a high-risk physical-topology mutation; success does not execute a device command, and clients must not automatically retry an incomplete audit or publication result.

Parameter	Type	Required	Description
action_point_id	integer	yes	Logical action-point ID within the instance model.
confirmed	boolean	yes	Explicitly confirms this high-risk physical topology change.
instance_id	integer	yes	Instance that owns the logical action point.

routing_action_set_enabled (WRITE)

Enable or disable an action route through the authenticated, explicitly confirmed, and audited application command. This is a high-risk physical-topology mutation; success does not execute a device command, and clients must not automatically retry an incomplete audit or publication result.

Parameter	Type	Required	Description
action_point_id	integer	yes	Logical action-point ID within the instance model.
confirmed	boolean	yes	Explicitly confirms this high-risk physical topology change.
enabled	boolean	yes	Whether the route participates in command dispatch.
instance_id	integer	yes	Instance that owns the logical action point.

routing_action_upsert (WRITE)

Change the physical C/A destination of an action route through the authenticated, explicitly confirmed, and audited application command. This is a high-risk topology mutation; success does not execute a device command, and clients must not automatically retry an incomplete audit or publication result.

Parameter	Type	Required	Description
action_point_id	integer	yes	Logical action-point ID within the instance model.
channel_id	integer	yes	Physical destination channel.
channel_point_id	integer	yes	Physical destination point ID within the channel.
channel_type	string	yes	Physical command-owned point type: C or A.
confirmed	boolean	yes	Explicitly confirms this high-risk physical topology change.
enabled	boolean	no	Whether the new route participates in command dispatch.
instance_id	integer	yes	Instance that owns the logical action point.

routing_list (read-only)

List all M2C/C2M routing entries

rules

rules_create (WRITE)

Create a disabled business-rule shell through the authenticated, explicitly confirmed, and audited rule-management application command. This is a high-risk rule-policy mutation; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms this high-risk rule-policy mutation.
description	string/null	no	Optional description
name	string	yes	Rule name

rules_delete (WRITE)

Delete a business rule through the authenticated, explicitly confirmed, and audited rule-management application command. This is a high-risk rule-policy mutation; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms this high-risk rule-policy mutation.
rule_id	integer	yes	Rule ID

rules_disable (WRITE)

Disable a business rule through the authenticated, explicitly confirmed, and audited rule-management application command. This is a high-risk rule-policy mutation; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms this high-risk rule-policy mutation.
rule_id	integer	yes	Rule ID

rules_enable (WRITE)

Enable a business rule through the authenticated, explicitly confirmed, and audited rule-management application command. This is a high-risk rule-policy mutation; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms this high-risk rule-policy mutation.
rule_id	integer	yes	Rule ID

rules_execute (WRITE)

Execute a rule now through the authenticated, explicitly confirmed, and audited application command. Selected device actions are accepted by the local command plane; success does not prove physical-device completion.

Parameter	Type	Required	Description
confirmed	boolean	yes	Explicitly confirms that the rule may dispatch real device commands.
rule_id	integer	yes	Rule ID

rules_get (read-only)

Get a specific business rule by ID

Parameter	Type	Required	Description
rule_id	integer	yes	Rule ID

rules_list (read-only)

List all business rules

rules_update (WRITE)

Update a business rule through the authenticated, explicitly confirmed, and audited rule-management application command. body is the partial rule update object. This is a high-risk rule-policy mutation; clients must not automatically retry an incomplete audit result.

Parameter	Type	Required	Description
body	-	yes	Partial update body – only fields present are changed
confirmed	boolean	yes	Explicitly confirms this high-risk rule-policy mutation.
rule_id	integer	yes	Rule ID

templates

templates_list (read-only)

List channel configuration templates, optionally filtered by protocol

Parameter	Type	Required	Description
protocol	string/null	no	Filter by protocol, e.g. “modbus”

Related pages

• Connect AI Assistants
• Safe Operations for Applications and Agents
• CLI Reference