- Category: model context protocol
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 99
- Triggers: 0
- Slug:
DOMOTZ_MCP - Version: 20261018_00
Tools
Apply device profile
Apply device profile
DOMOTZ_MCP_APPLY_DEVICE_PROFILEApplies a device profile (a saved bundle of sensors, and optionally credentials) to one or more devices. Apply runs as a background job — the tool blocks for up to poll_timeout_seconds (default 60s, max 120s) waiting for completion. If the job finishes within that window, per-device results are returned. If it times out, a partial state is returned; you can wait and call this tool again with the same arguments — apply is idempotent in REPLACE mode. IMPORTANT: a successful call does NOT mean every requested device was configured. Report the apply as complete only when applied_count covers every requested device; any other count being non-zero means it is not. Consult retryable rather than your own judgement before calling again. Devices on collectors you lack the Device Management permission on are skipped: they come back with result WITHHELD and an explanation. Whenever the apply is dispatched, every requested device carries exactly one verdict in per_device — OK, FAIL, WITHHELD, NOT_APPLIED (the job did not cover it), UNKNOWN (outcome undeterminable) or PENDING — and the per-verdict counts add up to the devices you asked for. Sometimes no job is created at all — job_status is NOT_STARTED, retryable is false and calling again cannot change the outcome; the cause varies (every device withheld, no devices matched, the profile has no modules), so relay the message instead of assuming a permission problem. other_issues carries anything the backend reported about something other than a device; it is normally empty, and a non-empty one is worth relaying rather than ignoring. If the profile contains credential modules, applying it WILL OVERWRITE existing credentials on the targeted devices, and this tool does not warn you when it does: read has_credentials from list_device_profiles before applying, and tell the user what will be overwritten. For applying alert rules to devices, use bind_alert_rule_to_device instead. Devices named in failed_device_ids carry no reason for their failure; WITHHELD devices, and devices affected by a job that failed or was cancelled as a whole, do carry one. Input-validation and dispatch errors return an error with a message and retryable, and no per-device detail.Input Parameters
Output
Attach driver
Attach driver
DOMOTZ_MCP_ATTACH_DRIVERAttach a driver to a device. THIS IS A LIVE OPERATION: the backend runs the driver’s validate() action against the device during attach and, once the binding is persisted, the scheduler will trigger the real (non-dry-run) actions (get_status for GENERIC, backup for CONFIGURATION_MANAGEMENT) on the device’s sample period.PRECONDITION: execute_driver must have returned outcome=success for every mandatory action (validate + get-status for GENERIC, validate + backup for CONFIGURATION_MANAGEMENT) against this (driver_id, collector_id, device_id) tuple. Because the driver is not yet attached, those execute_driver calls run in dry-run mode automatically and persist nothing — they exist precisely to catch failures before this attach. Skipping them and relying on attach_driver’s implicit validate() alone hides failures of get_status / backup until the next scheduled run.Provide params as a list of {name, value} pairs matching the driver’s PARAMETER SCHEMA (the inputs declared on the driver — NOT for credentials). The tool resolves names to internal parameter IDs before dispatch (unknown names are rejected). Sample period defaults to the driver’s minimum; that’s not configurable in this beta. To remove the binding later use detach_driver; to delete the driver everywhere use delete_driver.credentials (SEPARATE top-level argument — DO NOT put inside params): {username: str, password: str, store?: bool}. Used for the validate() call that runs during attach. On a successful attach, the backend’s result reporter persists these credentials in the credential store AND seeds the device’s purpose row (CUSTOM_DRIVER_MANAGEMENT for GENERIC drivers, CONFIGURATION_MANAGEMENT for CM drivers). After that, set_device_credential(purpose=...) works for rotation. For CONFIGURATION_MANAGEMENT drivers on devices that don’t already have a CM purpose row, you MUST pass credentials here — calling set_device_credential first will fail with 412 (scope missing). Common LLM mistake: passing credentials as an entry in params like {name: 'credentials', value: {username, password}}. That goes to the driver’s parameter list and is NOT used for authentication. The tool rejects this shape with WRONG_FIELD_SHAPE so you can resubmit with the top-level credentials arg.If the driver is already attached, returns result=ALREADY_ATTACHED with the existing binding_id. If the backend rejects the attach for another reason (e.g. driver validation error), returns result=CONFLICT with the error details. If the driver’s validate() action fails, returns result=VALIDATION_FAILED with the driver error and a remediation hint.Input Parameters
Output
Attach sensor
Attach sensor
DOMOTZ_MCP_ATTACH_SENSORAttach a sensor to a device. sensor_spec.kind selects the variant: overlay applies a preconfigured sensor (use list_preconfigured_sensors to discover overlay_id, optional selected_fields to subset its fields); tcp_port monitors a TCP port on the device (port 1..65535); custom_oid defines a per-device custom SNMP-OID sensor — required: oid (dotted notation, e.g. 1.3.6.1.2.1.1.3.0), name (short identifier), value_type (1|STRING, 2|NUMERIC, 3|ENUM — accepted as int id or label), description (human-readable text); optional: custom_name. Each custom_oid call creates a new per-device sensor entity — the same OID attached to multiple devices yields independent sensors. Sensor limits per collector apply; duplicate overlay attachments return a structured FAIL with a clear reason. No detach in this beta — remove via the UI.Input Parameters
Output
Bind alert rule to collector
Bind alert rule to collector
DOMOTZ_MCP_BIND_ALERT_RULE_TO_COLLECTORBind an existing alert rule to a collector. Use this for collector-scoped metrics such as agent_status or agent_performance/*. Already-bound combinations return status=ALREADY_BOUND rather than an error (idempotent retry-safe). Use after create_alert_rule (with the returned id) or after picking an existing rule from list_alert_rules. Before binding, call get_collector_alert_rule_bindings to verify the rule is not already bound to this collector.Input Parameters
Output
Bind alert rule to device
Bind alert rule to device
DOMOTZ_MCP_BIND_ALERT_RULE_TO_DEVICEBind an existing alert rule to a specific device. The system will then watch every variable on that device whose metric matches the rule and raise incidents when the rule’s condition is met. Use after create_alert_rule (with the returned id) or after picking an existing rule from list_alert_rules. Before binding, call get_device_alert_rule_bindings to verify the rule is not already bound to this device (binding-level dedupe). For variable-level dedupe — checking whether a suitable rule already exists for a specific variable — use list_variable_alert_rule_candidates before creating a new rule. Already-bound combinations return status=ALREADY_BOUND rather than an error (idempotent retry-safe). SENSOR CHECK: verify device has sensor data for the metric before binding (see alert_rule_id parameter). ICMP CAVEAT: latency/packet-loss rules require ICMP — check device_performance for 100% packet_loss_percent before binding, as many devices (firewalls, hardened hosts) block ICMP. BINARY METRIC: bind only one rule per binary metric (device_status, heartbeat) per device to avoid duplicate incidents.Input Parameters
Output
Bind collector to organization
Bind collector to organization
Close remote connection
Close remote connection
DOMOTZ_MCP_CLOSE_REMOTE_CONNECTIONClose a remote connection opened with create_remote_connection, invalidating its URL and releasing the collector’s remote-access allowance immediately. Any browser tab or client still using it drops, so close only what the user is done with. Connections also expire on their own (at most an hour), but until then they stay reachable by anyone holding the URL — closing an unneeded one is the only way to revoke it. Source session_id and device_id from list_remote_connections.Input Parameters
Output
Collector discovery status
Collector discovery status
Collector overview
Collector overview
DOMOTZ_MCP_COLLECTOR_OVERVIEWFetch a high-level overview of a collector including its identity, health status, software version, uptime/downtime intervals, device counts, security issues, speed test results, and IP conflict status. Also reports these settings, all changed with update_collector_settings (null means the value could not be read, not that it is off): tcp_open_port_scanner (the scheduled scan of the site’s public IP for open TCP ports), round_trip_delay_monitoring (the periodic ping of managed devices for latency and packet loss), and local_web_interface (whether the collector exposes the devices’ local web interfaces). Pass lookback (in days, 1-90, default 7) to widen or narrow the uptime window. Note: when the collector is OFFLINE, live fields populated by the collector (speed test, IP conflict) coalesce to null — null means ‘no recent push’ rather than ‘never ran’. Counters and uptime stay populated server-side. Use as the first call to understand the overall state of a collector before diving deeper.Input Parameters
Output
Compare config backup
Compare config backup
DOMOTZ_MCP_COMPARE_CONFIG_BACKUPCompares two configuration backup snapshots of the same device. config_type selects which side(s) to compare: running (default), startup, or both. Returns a unified diff (LCS) when both sides are <= 5000 lines; falls back to a set-based added / removed listing otherwise. When MD5s match, diff_strategy is md5_match and the summary is empty. max_diff_lines (default 200) caps the returned diff_text.Input Parameters
Output
Create alert rule
Create alert rule
DOMOTZ_MCP_CREATE_ALERT_RULECreate an alert rule. The rule fires when the named metric matches the given condition against the provided operands. function accepts a name (e.g. ‘GREATER_THAN’, ‘LESS_THAN’, ‘RANGE’) or a numeric function_id (e.g. ‘2’). Call list_metric_functions first to discover valid functions and their required operand count for the chosen metric. severity must be one of: Critical / High / Warning / Info. channel_ids must list at least one notification channel — a rule without channels notifies no one (use list_communication_channels to discover valid IDs). The rule’s metric is IMMUTABLE after creation: changing the target metric requires deleting the rule via the UI and creating a new one. After creation, use bind_alert_rule_to_device to bind the rule to specific devices or variables.Input Parameters
Output
Create contact
Create contact
Create device profile
Create device profile
DOMOTZ_MCP_CREATE_DEVICE_PROFILECreates an empty device profile in the account. A device profile bundles sensor definitions and credentials that can be applied to devices in one go. The new profile has no modules yet, so applying it changes nothing until content is added to it - report the profile as created, not as ready to apply. Returns the new id, which update_device_profile, apply_device_profile and delete_device_profile all take. Reversible via delete_device_profile. Names are not unique and this tool is not idempotent: if a call fails without telling you whether the profile was created, check with list_device_profiles before calling again, or you will end up with two profiles of the same name.Input Parameters
Output
Create organization
Create organization
DOMOTZ_MCP_CREATE_ORGANIZATIONCreate a new Organization for the calling account. Returns the new internal id. organization_id is an optional caller-defined reference (e.g. a CRM id); it is stored as-is and is not used to address the organization. Reversible via delete_organization. Requires MCP access on the account.Input Parameters
Output
Create remote connection
Create remote connection
DOMOTZ_MCP_CREATE_REMOTE_CONNECTIONOpen a temporary remote connection to one port of one device behind a collector, and return how to reach it. For rdp, ssh and telnet the answer is a web_portal URL that opens a Domotz browser session against the device; http/https proxy the device’s own web interface the same way; tcp instead returns a tcp_endpoint (host + port) to dial with a local client. TREAT THE RETURNED URL AS A CREDENTIAL: anyone holding it reaches the device with no further authentication until the connection expires, so hand it only to the person who asked and never store it. The connection consumes the customer’s remote-access allowance and holds a container until it expires or is closed — close it with close_remote_connection as soon as it is no longer needed. Source device_id and the open port from device_inventory / get_device_interfaces. If a web-portal connection for the same device, port and protocol is already open it is returned instead of a second one being created, with reused: true and no URL (the one issued at creation cannot be re-derived), so close it and call again for a fresh link. A tcp call always opens a new connection: its endpoint only answers the public_ip it was opened for, so an existing one cannot be handed to a different caller.Input Parameters
Output
Create tag
Create tag
DOMOTZ_MCP_CREATE_TAGCreate a new user-defined tag. color is cosmetic and user-visible: do not pick one yourself — ask the user which colour they want, and omit the parameter when you cannot ask (omitted means gray). Valid values are in the color enum, and update_tag can recolour later without affecting any bindings. The new tag becomes immediately usable as a filter in search_devices / search_collectors, as an assignable id in bind_tags, and can be renamed or recoloured with update_tag. Reversible with delete_tag. For MSP accounts the tag namespace is account-wide. Requires the manage_device_tags permission; callers without it receive a permission error.Input Parameters
Output
Cycle outlet power
Cycle outlet power
DOMOTZ_MCP_CYCLE_OUTLET_POWERPower-cycle a single outlet on a host device (PoE switch / PDU). The powered device will experience a brief outage while the outlet turns OFF and back ON. Although the outlet itself returns to its prior ON state, the device may suffer config corruption or data loss during the cycle — treat as a recovery action of last resort. The cycle is dispatched asynchronously (HTTP 202): the response confirms dispatch, not completion. Source host_device_id and outlet_id from the power_source block returned by device_inventory for the powered device; that block is present only when the device is on a managed PoE switch or PDU and is the indicator that power-cycling is supported. Re-query device_inventory afterwards to inspect power_source.link_freshness.Input Parameters
Output
Delete alert rule
Delete alert rule
Delete contact
Delete contact
Delete device
Delete device
DOMOTZ_MCP_DELETE_DEVICEPERMANENTLY delete one or more device records from a collector: the device and its history are removed entirely. This is IRREVERSIBLE - deleted devices cannot be recovered (though a device may be rediscovered later if it is still present on the network). Accepts a single device_id (int) or a list of device_ids (list[int]) for bulk deletion - all devices must belong to the same collector. Devices that no longer exist are reported as not-found and skipped (no error). Use search_devices to find device_ids before deleting.Input Parameters
Output
Delete device profile
Delete device profile
DOMOTZ_MCP_DELETE_DEVICE_PROFILEPermanently deletes a device profile and everything it contains. This cannot be undone. It does NOT undo anything the profile already applied: sensors and credentials written to devices by earlier applies stay exactly as they are, so deleting a profile is not a way to roll one back. Any schedule on the profile is removed with it, so a scheduled apply stops. Check the profile with list_device_profiles first, so you can name what is being deleted.Input Parameters
Output
Delete driver
Delete driver
DOMOTZ_MCP_DELETE_DRIVERPermanently delete a driver from the account. This is IRREVERSIBLE: the driver disappears for every device it was attached to, all existing bindings are removed, and the scheduler stops running it everywhere. Persisted metrics and configuration backups produced before deletion remain in their respective stores — only the driver definition and its bindings are removed. ALWAYS confirm with the user before calling; in particular, list the devices that currently have the driver attached so the user understands the blast radius. Use get_driver_catalog for the driver catalog and list_device_drivers per device to enumerate bindings. If the intent is just to stop running the driver on ONE device, use detach_driver instead.Input Parameters
Output
Delete organization
Delete organization
Delete tag
Delete tag
DOMOTZ_MCP_DELETE_TAGDelete a user-defined tag by ID. Irreversible — the tag is removed and unbound from every device and collector it was assigned to. Use list_tags to discover valid IDs. Idempotent: deleting a non-existent tag returns status=NOT_FOUND (no error). Fails with TAG_IN_USE if the tag is still referenced by one or more custom filters; the response lists the blocking filters so the caller can edit or remove them first. Requires the manage_device_tags permission.Input Parameters
Output
Detach driver
Detach driver
DOMOTZ_MCP_DETACH_DRIVERRemove the binding between a driver and a device on the given collector. The driver itself stays in the account and remains attached to other devices — only THIS device’s binding is removed. The scheduler will stop running the driver on this device; any metrics already emitted are preserved. CONFIGURATION_MANAGEMENT drivers: previously persisted backups remain in storage and the device’s CONFIGURATION_MANAGEMENT purpose row stays in the credential store (rotate or delete credentials via set_device_credential / UI if needed). To delete the driver everywhere instead, use delete_driver. Pass device_id+collector_id+driver_id; if no binding exists, the tool returns result=NOT_ATTACHED (idempotent — safe to call repeatedly).Input Parameters
Output
Detach sensor
Detach sensor
DOMOTZ_MCP_DETACH_SENSORDetach a preconfigured (overlay) sensor from a device. Irreversible — the overlay link is removed and the sensor stops collecting. Use list_device_sensors to discover the overlay_id for currently attached overlay sensors. Only overlay (preconfigured) sensors can be detached via MCP: TCP-port sensors and custom OID sensors must be removed via the UI in this beta. Idempotent: detaching a non-attached overlay returns status=NOT_FOUND (no error).Input Parameters
Output
Device inventory
Device inventory
DOMOTZ_MCP_DEVICE_INVENTORYReturns detailed information about a single device: identity, status, capabilities, protocol coverage, attached sensors/drivers/profiles, OS info, location, power source, and end-of-life (EOL) status for firmware, software, and hardware. Includes collector_id and collector_name — the numeric id (and display name) of the collector that monitors this device; needed for any subsequent metric tool call. The power_source section (when present) carries host_device_id, outlet_id, outlet_type, link_source, link_freshness, available_power_actions and, when no action is available, power_actions_unavailable_reason. available_power_actions lists what set_device_power accepts for this device right now (on, off, cycle, software_reboot); use host_device_id + outlet_id only for the older cycle_outlet_power. The protocol field describes how the device is represented: ‘ip’ (a standard network device with its own IP address); ‘grouped’ (a device that merges multiple network interfaces (NICs) on the same physical host into one logical device - it is online if any of its member interfaces is online, and the member interfaces are represented by this single grouped device); ‘logical’ (a manually-managed placeholder device with no IP - its status is set manually, not auto-monitored). Use for questions about what a device is, its hardware/software, installed services, where it is, how it is powered, or whether it has reached end-of-life. When presenting results, always refer to devices by name, not just by ID.Input Parameters
Output
Device performance
Device performance
Execute driver
Execute driver
DOMOTZ_MCP_EXECUTE_DRIVERRun an action of a driver against a device. The tool auto-selects mode based on whether the driver is attached to the device:- NOT attached → DRY-RUN. The action runs on the device (real network, real credentials) but nothing is persisted: no metric stored, no backup row created, no binding made. Use this to smoke-test newly created drivers BEFORE attach_driver. Response includes
mode: 'dry-run'. - ATTACHED → LIVE. Standard execution against the existing binding. Results are persisted by the scheduler/backend as usual. Response includes
mode: 'live'. The binding must havecode_is_valid: trueandstatus: ENABLED.
action_id values: validate, get-status, backup, restore, custom-N. For GENERIC drivers dry-run validate then get-status; for CONFIGURATION_MANAGEMENT dry-run validate then backup. params is a list of {name, value} pairs; types are derived from the driver’s parameter schema.credentials (SEPARATE top-level argument — DO NOT put inside params): pass {username: str, password: str, store?: bool} to use ad-hoc credentials for this single execution instead of (or in addition to) any credentials previously saved via set_device_credential. Useful in the dry-run loop to try a credential without persisting it. store defaults to false in dry-run, true in live mode — set explicitly to override. Passwords are redacted in audit logs. Common LLM mistake: passing credentials as an entry in params like {name: 'credentials', value: {username, password}}. That goes to the driver’s parameter list and is IGNORED by the authentication path — the call then fails with INVALID_CODE/PRECONDITION because no real credentials reached the sandbox. The tool rejects this shape with WRONG_FIELD_SHAPE so you can resubmit with the top-level credentials arg.Logs are capped at 100 lines.DRY-RUN OUTPUT: when mode: 'dry-run', the response also surfaces what the driver WOULD emit, so you can verify before attaching: metrics (GENERIC metric table), variables (legacy scalar variables), tables, and backup (CONFIGURATION_MANAGEMENT running/startup, each truncated to 4000 chars with a *_truncated: true flag). These keys appear only when present and only in dry-run; live runs persist results and omit them.Input Parameters
Output
Get account info
Get account info
DOMOTZ_MCP_GET_ACCOUNT_INFOReturns identity and account context for the currently authenticated user: user ID, email, billing state, trial end date, whether the user is the account owner, and whether RBAC is enabled. For freemium users, also includes current device usage and limits. Use this as the first call to understand who you are acting as and what account capabilities are available.Input Parameters
Output
Get audit log filters
Get audit log filters
DOMOTZ_MCP_GET_AUDIT_LOG_FILTERSReturn the set of values available for filtering Domotz audit logs: the operation categories (each with its operation types), source applications, target entities, actor entities, and outcome statuses currently present in the data. Use this to discover valid arguments for search_audit_logs before searching.Input Parameters
Output
Get collector alert rule bindings
Get collector alert rule bindings
Get collector capabilities
Get collector capabilities
DOMOTZ_MCP_GET_COLLECTOR_CAPABILITIESInspect what the customer’s Collector can actually run. Without driver_id, returns the Collector’s current sandbox module version plus the full supported / unsupported D.* symbol lists. With driver_id, returns a compatibility diff for that specific driver against this Collector, including a compatible flag and any missing_features. Use this BEFORE attach_driver / execute_driver to warn the customer when the Collector is behind on the sandbox version the driver requires — execute will otherwise fail with HTTP 412 inside execute_driver.Input Parameters
Output
Get collector credential coverage
Get collector credential coverage
DOMOTZ_MCP_GET_COLLECTOR_CREDENTIAL_COVERAGECollector-wide credential audit. Returns only credential STATUS and metadata (integration status, SNMP reading sub-status). Does NOT return passwords, private keys, or SNMP community strings. Returns every visible device on the collector (including those with has_working_credentials: false so missing-credential gaps are visible) along with its enabled integration purposes — SNMP_MANAGEMENT, OS_MONITORING, CONFIGURATION_MANAGEMENT, ONVIF_CAMERA, DEVICE_MANAGEMENT — and whether each purpose’s credentials are working (UNLOCKED) or not yet validated (LOCKED). SNMP_MANAGEMENT integrations include snmp_reading_status (CHECKING / NOT_FOUND / NOT_READING_DATA / READING_DATA) when available. has_working_credentials is true only when at least one purpose has valid, working credentials. Status mapping to get_device_credentials: UNLOCKED = AUTHENTICATED; LOCKED = any of REQUIRED / PENDING / WRONG_CREDENTIALS / NO_AUTHENTICATION. For per-protocol credential drill-down on a specific device (SSH/HTTP/etc.), use get_device_credentials.Input Parameters
Output
Get config backup entry
Get config backup entry
DOMOTZ_MCP_GET_CONFIG_BACKUP_ENTRYReturns a single configuration backup snapshot’s text for a device. config_type selects which block to return: running, startup, or both (default). When running and startup configs are identical, configs_match is true and only the running block is populated for both. Each block carries text plus line_count, truncated, and returned_lines so the caller knows whether it was capped. max_lines (default 1000) caps each block independently — large enterprise configs can exceed this; raise the cap if a fuller view is needed.Input Parameters
Output
Get config backup status
Get config backup status
DOMOTZ_MCP_GET_CONFIG_BACKUP_STATUSLists devices on a collector that have configuration backup (‘config backup’) enabled, with the active backup driver, mode (READ_WRITE / READ_ONLY / AVAILABLE / INSUFFICIENT_PRIVILEGE / ERROR), status (ENABLED / DISABLED), failed-inspection count, and last inspection time. Devices without a detected backup driver are simply absent — this is not an error. Driver values include CISCO_IOS, CISCO_SG30X, CISCO_CBS, LUXUL_SMBSTAX, WATCHGUARD_FIREWARE_OS, WATCHGUARD_FIREWARE_OS_TFTP, FORTIGATE, FORTIGATE_TFTP, JUN_OS, HP_ARUBA_OS, HP_ARUBA_OS_AP, HP_ARUBA_OS_CX, HP_ARUBA_OS_SWITCH, SONICWALL, MIKROTIK, NETGEAR_OS_SWITCH, DELL_OS_SWITCH.Input Parameters
Output
Get create tag form
Get create tag form
DOMOTZ_MCP_GET_CREATE_TAG_FORMShows an interactive form to create a new custom tag, with a name field and a color picker. Use this tool when the user asks to create a new tag. If the user already stated the tag name or the color, pass them as the “name” and “color” arguments so they are pre-selected and the user does not have to enter them twice. Leave an argument out when the user did not mention it: the color then defaults to gray. This tool only creates a tag; it does NOT apply it to devices or collectors, and does NOT list or search existing tags.Input Parameters
Get device alert rule bindings
Get device alert rule bindings
DOMOTZ_MCP_GET_DEVICE_ALERT_RULE_BINDINGSList alert rules bound to a specific device, including device-level bindings and bindings to variables owned by that device. Requires both collector_id and device_id. Use to see which alert rules are active on a device and which metrics they target. Call before bind_alert_rule_to_device to verify the rule is not already bound.Input Parameters
Output
Get device alerts
Get device alerts
Get device credentials
Get device credentials
DOMOTZ_MCP_GET_DEVICE_CREDENTIALSPer-device credential status drill-down. Returns only credential STATUS and metadata (authentication status, SNMP version, public-key fingerprint, timestamps). Does NOT return passwords, private keys, or SNMP community strings. Covers SNMP version + reachability status, and per-protocol access keys (SSH / TELNET / HTTP / HTTPS / WINRM / ONVIF) with their authentication status and (where available) public-key fingerprint. Status enums — snmp.status: CHECKING / NOT_FOUND / NOT_READING_DATA / READING_DATA; access_keys[].authentication_status: AUTHENTICATED / REQUIRED / PENDING / WRONG_CREDENTIALS / NO_AUTHENTICATION. snmp is null when no SNMP data exists. Status mapping to get_collector_credential_coverage: AUTHENTICATED = UNLOCKED; any of REQUIRED / PENDING / WRONG_CREDENTIALS / NO_AUTHENTICATION = LOCKED. For collector-wide credential gap analysis, use get_collector_credential_coverage.Input Parameters
Output
Get device history
Get device history
DOMOTZ_MCP_GET_DEVICE_HISTORYReturns the per-device History / Event Log for a single device: the chronological stream of events the device generated, most recent first. Events include availability transitions (UP/DOWN), IP_CONFLICT_DETECTION / IP_CONFLICT_RESOLUTION, CREATED, IP_CHANGE, CONFIGURATION_CHANGE, CONFIGURATION_MISALIGNMENT. Each entry carries a timestamp (ISO 8601) and an event name; when the backend recorded extra context (e.g. the IP or MAC address involved) it is returned in a details object. Requires collector_id and device_id. Optional event_type filters to a single event name from the fixed set above (case-insensitive). Optional from/to accept ISO 8601 timestamps and bound the time window; the backend caps a query at 31 days. If neither is given, the most recent events are returned; if only one is given the window defaults to 7 days. This is the device-level event stream, distinct from get_device_alerts (monitoring-profile alert configuration) and search_alerts (fired incidents).Input Parameters
Output
Get device interfaces
Get device interfaces
DOMOTZ_MCP_GET_DEVICE_INTERFACESLists the SNMP-collected interfaces on a device. Returns id as a string (= ifIndex, pass directly to get_interface_traffic.interface_ids), name, alias, description, admin/operational status (IF-MIB enums: up/down/testing/unknown/dormant/notPresent/lowerLayerDown), high-speed (Mbps), type (human-readable IANA ifType label, e.g. ‘ethernetCsmacd’, ‘ieee80211’, ‘tunnel’, ‘ieee8023adLag’), and per-interface error/discard counters. Devices without SNMP credentials yield an empty result. max_interfaces (default 100) caps the returned list; when truncated, truncated: true and total_count indicate that more exist.Input Parameters
Output
Get device metrics
Get device metrics
DOMOTZ_MCP_GET_DEVICE_METRICSFetch summarised time-series analytics for one or more named metrics on a device within a time range. metric_names is capped at 15 per call and the total variables analysed across all metrics is capped at 30 (each metric can fan out to multiple variables, each analysed independently by the time-series analysis backend). Numeric variables are returned under variables with full analytics; text variables (e.g. status strings, hostnames, firmware versions) are returned under text_variables with latest, count, and distinct_values instead — they have no statistical analysis, so include_anomalies and include_change_points are ignored for them. view=summary (default) returns scalar stats only ({min, max, avg, latest, count, std, trend_slope, seasonality}); view=timeseries adds bucketed time/values arrays per variable, trimmed to max_datapoints (default 50). include_anomalies adds rolling-MAD anomaly points. include_change_points adds PELT segment break-points. from/to accept ISO 8601 timestamps; default window is the last 7 days (the time-series analysis backend needs a multi-day baseline for anomalies and change-points). Source metric_names from list_collector_metrics or list_device_sensors.Input Parameters
Output
Get device profile job history
Get device profile job history
DOMOTZ_MCP_GET_DEVICE_PROFILE_JOB_HISTORYLists device-profile apply jobs for the account: which profile was applied, who submitted it, when it started and ended, how it finished, and which devices failed. Use it to answer whether an earlier apply succeeded without applying anything again. Applies still in progress are included: they come back with in_flight true, a non-terminal status (PENDING or RUNNING) and no end_date. An in-flight row means the apply is still going: wait for it. A second apply of the same profile is refused with a conflict while one is running, so retrying is not just wasteful, it fails. failed_count and failed_device_ids are present only when details_recorded is true; until then the per-device outcome is not written yet and their absence must not be read as nothing having failed. Optional filters: profile_id, status (RUNNING, COMPLETED, FAILED, CANCELLED), and limit (default 20, max 100). author is absent when the submitter cannot be named - a deleted user, or an apply no person submitted - so a missing author is not the same as an unattributed apply. IMPORTANT: this returns a bounded, recent slice of the account’s apply jobs, not a complete record, and profile_id filters that slice rather than searching the profile’s whole history. job_count 0 therefore means no matching apply is in the slice, NOT that the profile has never been applied - on its own it is never a reason to apply again. A call that fails answers with an error field instead, so an empty list is always a real answer and not a hidden failure. A job names its failed devices but not why each one failed.Input Parameters
Output
Get driver catalog
Get driver catalog
DOMOTZ_MCP_GET_DRIVER_CATALOGLists the account-wide catalog of drivers available for attaching and executing on devices. Each entry returns the id (use as driver_id in attach_driver / execute_driver), name, description, type, minimal_sample_period, last_saved_time, and a parameters array describing each input (name, label, value_type, default value) — empty when the driver declares none. code_is_valid: false ⇒ the driver will fail at execute time and should not be attached. credentials_required: true ⇒ the device must have credentials configured before the driver can run; if absent, attach will fail.Input Parameters
Output
Get driver template
Get driver template
Get interface traffic
Get interface traffic
DOMOTZ_MCP_GET_INTERFACE_TRAFFICReturns traffic counters for one or more device interfaces over a time range. Octets are reported in bps (per-period delta). interface_ids accepts strings or integers (pass the id values returned by get_device_interfaces directly); capped at 5 per call. view=summary (default) returns avg/max bps and total errors/discards; view=timeseries adds downsampled time/values arrays per interface, capped at max_datapoints (default 50) and limited to in/out octets unless include_error_series=true. from/to accept ISO 8601 timestamps; default window is the last 24 hours.Input Parameters
Output
Get network configuration
Get network configuration
DOMOTZ_MCP_GET_NETWORK_CONFIGURATIONFetch what a collector actually scans, to answer ‘why isn’t this device discovered?’. Read-only. Returns:discovery_settings: the three flags bounding the scan.broadcast_discoveryis the decisive one: ON means the collector sweeps its subnets and picks up devices as they connect; OFF means it only probes the IPs already known to the cloud plus the forced ones, so a new device is never found and a known device that changes IP via DHCP just goes offline (ONVIF, SSDP/UPnP and mDNS discovery stop too; external hosts keep being probed).scan_all_interface_ipsOFF means only the FIRST address of each network interface defines a subnet to scan, so secondary addresses and VLAN sub-interfaces are never scanned - the usual cause on a multi-homed collector.dhcp_device_discoveryON reports devices seen asking for a DHCP lease but never answering a scan (they appear with no IP); it needs the collector to sit in the same broadcast domain.interfaces:attachedare the interfaces the collector is physically attached to - the subnet of each is scanned with ARP ping at layer 2, andvlan_idis the VLAN it is tagged with (null when untagged), so the VLANs the collector sits on are the non-null ones.routedmirrors the routed networks below.routed_networks: subnets NOT reachable at layer 2, only through a router, so they are scanned without ARP ping and answered at layer 3 only.scan_probesis the probe set nmap runs for that network (ICMP echo/timestamp, TCP SYN or TCP ACK on given ports); null means the collector’s default set, which is ICMP echo only -advanced_discoveryis what adds the extra TCP probes. Those extra probes are one collector-wide configuration copied onto every network with the flag on, soscan_probesis identical across them - the per-network choice is only whether they apply. Devices found this way carry a synthetic MAC startingCS:TM:followed by the IP in hex. Public ranges cannot be routed networks.external_hosts: single monitored addresses, the equivalent of a /32 routed network; they accept a hostname or an IP and may be public, and appear with aEX:TN:MAC.external_host_scan_policyis the ICMP/TCP probe set deciding whether they are up - one value for ALL external hosts of the collector, not per host.ip_scan_policy: subsets of addresses to scan (layer 2 and layer 3 alike) - forced IPs or IP ranges, used to monitor specific addresses instead of whole subnets.interfaces_policy:policyplusrules, patterns on the interface name where*is a wildcard. Withdeny, a matching interface is NOT scanned (no rule = every interface is scanned, the default); withallow, ONLY matching interfaces are scanned (no rule = nothing is scanned at all).unavailable: sections whose backend read failed. They are returned empty as a fallback, so an empty section listed here means ‘not read’, NOT ‘nothing configured’ - never diagnose from it. The threediscovery_settingsflags are changed withupdate_collector_settings; everything else here has its own write tool (manage_routed_networks,manage_external_hosts,manage_ip_scan_policy,set_interfaces_policy). Typical causes of a missing device: broadcast_discovery off, a subnet that needs a routed network, an interface excluded by the interfaces policy, or an address outside the IP scan policy.
Input Parameters
Output
Get organization
Get organization
DOMOTZ_MCP_GET_ORGANIZATIONGet the full details of a single Organization by its internal id: name, organization_id (the caller-facing reference), its Contacts, and the ids of the Collectors bound to it. Use search_organizations or list_organizations first to resolve a name or organization_id to an id.Input Parameters
Output
Get snmp credentials form
Get snmp credentials form
DOMOTZ_MCP_GET_SNMP_CREDENTIALS_FORMShows an interactive form to set or update SNMP credentials on a specific device.Only use this tool when the user explicitly asks to set, update, or change SNMP credentials for a deviceDo NOT use for listing, searching, or querying devices or collectors.Input Parameters
Get uptime
Get uptime
DOMOTZ_MCP_GET_UPTIMEReturns uptime stats for a collector or device over a time range: total uptime percentage, online_seconds, total_seconds, and the list of downtime intervals. If device_id is omitted the response covers collector uptime; if provided, it covers device uptime (with agent_uptime showing how much of that range the collector itself was online). The backend caps individual queries at 31 days; obi splits longer ranges into 31-day chunks (parallel) and merges them, with an obi-side ceiling of 90 days. from/to accept ISO 8601; default window is the last 7 days.Input Parameters
Output
Inspect driver
Inspect driver
DOMOTZ_MCP_INSPECT_DRIVERStatic analysis of a driver’s JS against the Domotz sandbox. Two modes: pass code+type to analyze a DRAFT statelessly (nothing persisted — use this in the authoring loop while iterating), OR pass driver_id to inspect a SAVED driver (returns its stored code, code analysis, code_is_valid, required_features, and its declared parameters). Provide exactly one mode — not both, not neither. Returns is_valid, the list of analyzer errors, and a summary of which D.* APIs the code references. When an error points at a D.* symbol you don’t recognize, read the per-symbol doc at MCP resource domotz://sandbox/api/{symbol} for signature, params, and examples (or domotz://sandbox/api/catalog for the full surface). Once is_valid is true, call save_driver to persist.Input Parameters
Output
List alert rules
List alert rules
DOMOTZ_MCP_LIST_ALERT_RULESLists alert rule definitions in the account. Each rule defines a condition and threshold that, when matched, fires an alert. This tool returns the rule definitions (id, name, metric, function, operands, severity, attached devices/collectors). It does NOT return fired alerts — use search_alerts for those. Optional entity filter narrows to rules attached to devices (device) or collectors (collector). The linked_entities field shows where the rule is currently attached. channel_ids are not returned for existing rules — they’re only available at rule creation time. Feeds create_alert_rule and bind_alert_rule_to_device.Input Parameters
Output
List collector metrics
List collector metrics
DOMOTZ_MCP_LIST_COLLECTOR_METRICSEnumerate the metrics available on a collector — speed-test thresholds, IP-conflict status, collector uptime, security-issues counts, and the rest of the collector-scoped metric catalog. Use this to discover what can be alerted on at the collector level. Use the returned metric values as input to alert rule creation.Input Parameters
Output
List communication channels
List communication channels
DOMOTZ_MCP_LIST_COMMUNICATION_CHANNELSList the user’s notification channels (email, webhook, Slack, etc.). Each channel has an id, endpoint, description, and type. Use to discover channel_ids before creating an alert rule via create_alert_rule (channel_ids is a required parameter).Input Parameters
Output
List config backup history
List config backup history
DOMOTZ_MCP_LIST_CONFIG_BACKUP_HISTORYLists configuration backup snapshots for a device on a collector, newest first. When running_md5 differs from startup_md5 the device has unsaved changes (running config diverges from what would persist across reboot). label is user-mutable; source (user / custom_driver / internal_driver) records who took the snapshot. Use next_before as the before cursor to fetch the next page. snapshot_timestamp is the chain identifier consumed by get_config_backup_entry and compare_config_backup.Input Parameters
Output
List device drivers
List device drivers
DOMOTZ_MCP_LIST_DEVICE_DRIVERSLists drivers currently attached to a device. Each binding returns the driver identity, the binding status, parameter values (with secrets pre-masked), and the list of executable actions (e.g. validate, get-status, backup, restore, custom-N) — pass an action’s action_id to execute_driver. status: DISABLED ⇒ the binding cannot be executed even when code_is_valid: true; re-enable via the UI before retrying. Empty actions[] ⇒ the driver is not executable.Input Parameters
Output
List device metrics
List device metrics
DOMOTZ_MCP_LIST_DEVICE_METRICSList everything monitorable on a device. Returns the metric catalog (what CAN be alerted on — always populated, even at discovery time). Pass metric (prefix match) to also include the live variable instances for that metric, with variable_id needed for variable-level binding. When metric is omitted, only the metric catalog is returned — use this to browse what’s available before drilling into a specific metric’s variables. Follow up with list_metric_functions to discover valid thresholds for a metric, and list_variable_alert_rule_candidates to check whether a suitable alert rule already exists.Input Parameters
Output
List device profiles
List device profiles
DOMOTZ_MCP_LIST_DEVICE_PROFILESLists device profiles in the account. A device profile bundles sensor definitions and credentials that can be applied to one or more devices. Use the returned id with apply_device_profile. The optional view parameter selects detail level: summary (default) returns module metadata only; full includes the per-module configuration JSON (~5x larger payload). profile_id narrows the answer to one profile: the account’s profiles are read either way, so it trims what you receive rather than the work done. Module types are SNMP_PRECONFIGURED_SENSOR, SNMP_CUSTOM_OID, TCP_SENSOR, CREDENTIAL, CUSTOM_TAG, INFO, SHARED_ALERT and ALERT_RULES. has_credentials is true when the profile applies credentials (applying it will overwrite credentials on targeted devices). schedule and next_run describe an automatic apply when one is configured; both are read-only here.Input Parameters
Output
List device sensors
List device sensors
DOMOTZ_MCP_LIST_DEVICE_SENSORSLists the sensors currently attached to a device, merged across CUSTOM_OID, TCP, CUSTOM_DRIVER, and PRECONFIGURED kinds. Every entry carries kind. CUSTOM_OID entries carry id, name, oid, description, value_type, category, custom_name — created via attach_sensor(sensor_spec={kind:'custom_oid', ...}). TCP entries carry name, port, service, status, last_update. CUSTOM_DRIVER entries carry id and driver_name (drivers, distinct from custom OIDs). PRECONFIGURED entries carry id, name, and category (overlays from list_preconfigured_sensors). Sibling tools: device_inventory for sensor counts only, get_device_metrics for time-series data, list_preconfigured_sensors for the account-wide overlay catalog.Input Parameters
Output
List device types
List device types
DOMOTZ_MCP_LIST_DEVICE_TYPESReturns the device-type catalog used to classify devices (router, switch, AP, server, etc.). Stable across calls within an API version. Each entry has an id (used as the type_id filter in search_devices) and a user-facing label. Use to discover valid type filters before constructing a search.Input Parameters
Output
List driver templates
List driver templates
DOMOTZ_MCP_LIST_DRIVER_TEMPLATESList shared driver templates the account can start from. Each entry returns id (use as template_id in get_driver_template and save_driver), name, category, type, and version. Templates are read-only starters; creating a driver from a template still produces a new, account-owned driver.Input Parameters
Output
List metric functions
List metric functions
DOMOTZ_MCP_LIST_METRIC_FUNCTIONSList the evaluation functions (e.g. GREATER_THAN, LESS_THAN, RANGE, CHANGED) available for a given metric name. Each function describes the comparison used to evaluate incoming variable values. Use to discover which threshold functions can be applied when creating or describing an alert rule.Input Parameters
Output
List organizations
List organizations
DOMOTZ_MCP_LIST_ORGANIZATIONSList the account’s Organizations with their Contacts and bound Collector ids. Each result carries the internal id (use it to address an organization) and the caller-facing organization_id. Optional filters (applied server-side): name (case-insensitive substring), organization_id (exact), collector_id (only the organization the collector is bound to). Sort by name (default) or id.Input Parameters
Output
List preconfigured sensors
List preconfigured sensors
DOMOTZ_MCP_LIST_PRECONFIGURED_SENSORSReturns the account-wide catalog of preconfigured sensors available to attach via attach_sensor(sensor_spec={kind: 'overlay', overlay_id: ...}). When device_ids is provided, each sensor includes a per-device attached flag indicating whether it is already attached to that device. Custom sensors (category=CUSTOM) are excluded. Sorted by supported_device_count descending — most-applicable first. Companion to attach_sensor. Distinct from list_device_sensors (per-device attached) and get_device_metrics (time-series data for a device).Input Parameters
Output
List remote connections
List remote connections
DOMOTZ_MCP_LIST_REMOTE_CONNECTIONSList the remote connections of a collector - by default the ones still open, with the device and port each reaches and how long before it expires. Use it to see what create_remote_connection has left open before opening another, and to get the session_id and device_id that close_remote_connection needs. It never returns how to reach a connection - the URL, or the tcp host and port - because those are issued once, at creation, and cannot be read back. Pass status=ALL for the last month’s history, including closed ones.Input Parameters
Output
List variable alert rule candidates
List variable alert rule candidates
DOMOTZ_MCP_LIST_VARIABLE_ALERT_RULE_CANDIDATESList alert rules that could be bound to a specific device variable. Each candidate includes an ‘attached’ flag: true means the rule is already bound to this variable, false means it could be bound. Use this right before creating a new alert rule, to reuse an existing one when possible.Input Parameters
Output
Manage external hosts
Manage external hosts
DOMOTZ_MCP_MANAGE_EXTERNAL_HOSTSAdd or remove an external host on a collector. An external host is a single address - a public or remote IP, or a hostname/FQDN - monitored as one device (the equivalent of a /32 routed network); public addresses are allowed here, unlike routed networks.- action=‘add’: needs
host(IP or hostname) andname. Optionallydevice_type_id(seelist_device_types; defaults to the generic type). Returns the newdevice_id. - action=‘remove’: needs
device_id. DESTRUCTIVE and irreversible: it deletes the device record and its history. Get the id fromget_network_configuration(external_hosts). Only external hosts can be removed here - an id that is not one is refused, usedelete_devicefor a regular device. How external hosts are probed (the ICMP/TCP probe set deciding whether they are up) is NOT settable here: it is a single collector-wide value shared by every external host, so it cannot be changed for one of them. Read it withget_network_configuration(external_host_scan_policy) and change it from the web app. Adding an external host consumes the account’s external-host and managed-device allowance; the backend rejects the call when either is exhausted.
Input Parameters
Output
Manage ip scan policy
Manage ip scan policy
DOMOTZ_MCP_MANAGE_IP_SCAN_POLICYManage the collector’s forced IP scan policy: extra addresses the collector must probe on top of what it discovers by itself. Use it for a device that never answers a normal discovery scan (silent host, outside the interface’s own subnet, ignores ARP/ICMP broadcast) so the collector keeps polling that address explicitly. This is an INCLUDE-only list: there is no way to exclude an address here - to reduce what gets scanned use set_interfaces_policy.- kind=‘ip’, action=‘set’:
ip_addressesREPLACES the whole forced address list. Read the current one withget_network_configurationand send it back with your additions, or you will drop the others. - kind=‘ip’, action=‘remove’: removes the single
ip_address. - kind=‘range’, action=‘set’:
ip_ranges(list of {‘start’: …, ‘end’: …}) REPLACES the whole forced range list. start must be lower than end. - kind=‘range’, action=‘remove’: removes the single range identified by
ip_range_id. Only IPv4. Public addresses are refused unless the account is allowed to use them, and the whole feature is plan-gated - the backend answers 403 when it is not enabled.
Input Parameters
Output
Manage routed networks
Manage routed networks
DOMOTZ_MCP_MANAGE_ROUTED_NETWORKSAdd, update or remove a routed network on a collector. A routed network is a subnet the collector cannot reach at layer 2 (no ARP), only through a router, so it is probed at layer 3 only; devices found there appear with a synthetic MAC address. Use it to monitor a subnet that lives behind a router.- action=‘add’: needs
address,subnet_maskandname.subnet_masktakes a dotted quad (‘255.255.255.0’) or a prefix length (‘24’); it must be /24 or narrower, the range must be private (public ranges are rejected) and must not overlap an existing routed network nor one of the collector’s own attached subnets. - action=‘update’: needs
routed_network_idplus the full newaddress/subnet_mask/name- it replaces, it does not patch.advanced_discoveryis part of that replace: omit it and the network keeps the value it has now, pass it to change it. - action=‘remove’: needs
routed_network_id. DESTRUCTIVE: it also deletes every device discovered inside that subnet, with its history.advanced_discovery(add/update) widens the probe set from ICMP echo only to ICMP plus a few TCP probes, finding devices that drop ICMP but answer TCP, at the cost of a slower and noisier scan. The flag is the only per-network choice: which probes ‘advanced’ means is one collector-wide configuration, identical for every routed network that has the flag on, and it cannot be changed from here - read it inget_network_configuration(scan_probes). Read the current routed networks and their ids withget_network_configurationfirst.
Input Parameters
Output
Network topology
Network topology
DOMOTZ_MCP_NETWORK_TOPOLOGYReturns the network topology discovered by a single collector: device-to-device links and per-outlet (port) details. view controls detail level — summary returns infrastructure-only counts (~10 nodes), standard (default) returns full nodes and edges, full adds an upstream dependency map plus the inferred root (gateway). max_links (default 200) caps the returned edges; when truncated, truncated: true and total_links indicate that more exist. Use to understand network structure, identify single points of failure, or trace upstream paths.Input Parameters
Output
Resolve alert
Resolve alert
DOMOTZ_MCP_RESOLVE_ALERTPermanently resolve one or more alert incidents. Resolution is IRREVERSIBLE — once resolved an incident cannot be re-opened. Domotz has no intermediate ‘acknowledged-but-not-fixed’ state; this tool transitions TRIGGERED / TRIGGERED_NO_AUTOMATIC incidents to RESOLVED. Bulk resolution is supported in a single call (pass an array of unique_ids). The optional note is captured in the audit trail. Source the UUIDs from search_alerts.alerts[].unique_id.Input Parameters
Output
Save driver
Save driver
DOMOTZ_MCP_SAVE_DRIVERCreate or update a driver on the account. Omit driver_id to CREATE a new driver (requires name, code, type); pass driver_id to UPDATE an existing one (only code, description, timeout are mutable — name/type are immutable here and rejected with FIELD_NOT_ALLOWED, change them in the UI). Account-scoped: no collector_id here — capability checks happen later via get_collector_capabilities or at execute time. On success returns driver_id, code_is_valid, and required_features (the D.* APIs the driver uses, useful for warning the customer if the target Collector lacks them), plus result (CREATED or UPDATED). On create, a name clash returns result=NAME_CONFLICT; on update, an unknown id returns result=NOT_FOUND. Iterate on inspect_driver until the code is valid before saving. Optional fields: description, timeout (0-120s), credentials_required, template_id (create only — start from a shared template).credentials_required (CRITICAL — getting this wrong silently breaks the driver): controls whether the sandbox receives the device’s persisted credentials when the driver runs.- Set TRUE if the JS code uses ANY of:
D.device.username(),D.device.password(),D.device.credentials,D.device.sendSSHCommand,D.device.sendSSHShellSequence,D.device.sendWinRMCommand,D.device.sendTelnetCommand, or HTTP options withauth: 'basic'and no inline username/password. - Set FALSE if the driver only makes anonymous HTTP calls, public-community SNMP reads, or passes inline credentials sourced from driver parameters (not from the device’s stored creds).
- If omitted, this tool auto-infers from the code (in BOTH create and update-with-
code) by scanning for the patterns above and includescredentials_required_auto_inferred: truein the response so you can verify. Override explicitly when the heuristic is wrong (e.g. the code uses encrypted creds via custom params, or credentials are passed inline at execute time only). Why it matters: withcredentials_required=false, the backend stripsdevice.device_access_keysbefore dispatch — the driver runs but every credential-bearing call sees empty values and fails non-obviously (auth errors, empty username in SSH, etc).
type (create only) — REQUIRED decision before writing any code:GENERIC: monitor observable values over time (CPU, temperature, link state, counters, port up/down, service health). Implements validate() + get_status(). Returns metrics viaD.success([D.createMetric({uid, label, value, unit?}), ...])— ALWAYS useD.createMetricas the first pick.D.createVariable(andD.device.createVariable) are the legacy fallback, used ONLY when the target Collector lacksSandboxCapabilityMetrics— confirm viaget_collector_capabilitiesbefore emitting createVariable. Do NOT use GENERIC to capture device configuration text.CONFIGURATION_MANAGEMENT: snapshot the device’s configuration (switch/router running-config and startup-config, firewall rules, AP config). Implements validate() + backup(). Returns config blobs viaD.success(D.createBackup({running, startup})). Do NOT use this type to emit metrics. Decision rule: is the output numeric/state values to chart over time, or a text blob representing device config? Metrics → GENERIC. Config text → CONFIGURATION_MANAGEMENT.
domotz://sandbox/types (driver type contracts with purpose, when_to_use, output_shape, and example use cases per type), domotz://sandbox/skeleton/{driver_type} (minimal valid starter with inline intent comments), and domotz://sandbox/api/catalog (every D.* symbol with signature, params, min sandbox version, and examples). Each D.* symbol is also readable individually via domotz://sandbox/api/{symbol}.Input Parameters
Output
Search alerts
Search alerts
DOMOTZ_MCP_SEARCH_ALERTSSearch alert history with filters. Returns both active and historical alerts. Each result carries the unique_id UUID (the chain identifier into resolve_alert(unique_ids=[...])), the status, severity, triggered_at/closed_at, the trigger_function_repr + trigger_value that fired the rule, and a context block with device/collector/profile snapshots. status ∈ TRIGGERED / TRIGGERED_NO_AUTOMATIC / CLOSED / RESOLVED — open alerts are TRIGGERED ∪ TRIGGERED_NO_AUTOMATIC. Default sort: triggered_at descending. Pass unique_ids=[…] to fetch specific incidents by UUID (exact match) — use this when you already know which incident(s) you want, instead of filtering by device/time and hunting through the result page.Input Parameters
Output
Search audit logs
Search audit logs
DOMOTZ_MCP_SEARCH_AUDIT_LOGSSearch Domotz audit logs for the caller’s organization. Filter by time range, operation type/category, target entity, actor, outcome status, and source application. Timestamps may be ISO 8601 strings (e.g. ‘2026-06-12T10:00:00Z’) or integer epoch seconds. Valid target_entity_type values: USER, COLLECTOR, DEVICE, DEVICE_PROFILE, USER_CREDENTIALS, ALERT_RULE, ALERT, CUSTOM_FILTER, CUSTOM_TAG (the monitoring appliance is a ‘COLLECTOR’). Results are sorted by event_timestamp descending by default.Input Parameters
Output
Search collectors
Search collectors
DOMOTZ_MCP_SEARCH_COLLECTORSSearch and list Domotz collectors with filtering and pagination (zero-based: first page is page=0). filter_by keys: name, collector_id, status (ONLINE/OFFLINE), health_status (HEALTHY/ISSUES/DOWN), organization_id, tag_ids (list, AND-ed), ip_prefix, owner_name, text_match (fuzzy across name/vendor/IP/owner). Returns data in three detail levels: ‘summary’ (id, name, status, ip, organization), ‘standard’ (default - adds tags, counters, platform, mac), ‘detailed’ (all available fields including licence, monitoring mode, software version). Use this tool to discover which collectors exist and their current state.Input Parameters
Output
Search devices
Search devices
DOMOTZ_MCP_SEARCH_DEVICESCross-account device search with filters and pagination (zero-based: first page is page=0). Supports filtering by text_match, name, ip_mac, vendor, model, collector_ids, status (ONLINE/OFFLINE), type_ids, tag_ids, organization_id, serial, room, zone, credential_types, credential_status, importance (important or not important), monitoring_state (device managed or device unmanaged), and device_id. Note: ONLINE includes devices within the heartbeat grace period; OFFLINE means the device has been unreachable past the grace period. Returns data in three detail levels: ‘summary’ (id, name, status, ip, collector_id, type), ‘standard’ (default - adds mac, vendor, model, importance, tags, organization, first_seen), ‘detailed’ (all fields including serial_number, zone, credentials/alerts/snmp flags). The ‘detailed’ view includes a protocol field describing how a device is represented: ‘ip’ (a standard network device with its own IP address); ‘grouped’ (a device that merges multiple network interfaces (NICs) on the same physical host into one logical device - it is online if any of its member interfaces is online, and the member interfaces are represented by this single grouped device); ‘logical’ (a manually-managed placeholder device with no IP - its status is set manually, not auto-monitored). Use this tool to discover and filter devices across your network. When presenting results, always refer to devices by name, not just by ID.Input Parameters
Output
Search organizations
Search organizations
DOMOTZ_MCP_SEARCH_ORGANIZATIONSList and filter the organizations visible to the calling user. The discovery entry-point for multi-tenant workflows: resolve an organization name to an id before scoping subsequent calls (e.g., search_collectors, search_devices). MSP accounts typically have many organizations; single-org accounts return a single result. with_offline_collectors_only narrows to organizations with at least one offline collector. The chain: search_organizations → search_collectors → search_devices.Input Parameters
Output
Set collector default snmp credentials
Set collector default snmp credentials
DOMOTZ_MCP_SET_COLLECTOR_DEFAULT_SNMP_CREDENTIALSSet the collector’s DEFAULT SNMP credentials — the ones used for devices that have no SNMP credentials of their own. Devices already configured keep theirs: to change one of those use set_device_credential. credential_spec.version selects the family: V1/V2 require community (optional write_community); V3_NO_AUTH requires username; V3_AUTH_NO_PRIV adds authentication_protocol + authentication_key; V3_AUTH_PRIV adds encryption_protocol + encryption_key. Protocol names carry hyphens: MD5 / SHA / SHA-224 / SHA-256 / SHA-384 / SHA-512 for authentication, DES / AES / AES-256B / AES-256R for encryption. OVERWRITES any default previously set on the collector. The feature is licensed: on plans without it the tool returns error=FEATURE_NOT_AVAILABLE. Never include the community string or any key in a user-visible message. Use collector_overview to read back which version is configured (secrets are never returned).Input Parameters
Output
Set device credential
Set device credential
DOMOTZ_MCP_SET_DEVICE_CREDENTIALSet or overwrite a device credential. credential_spec.kind selects the credential family. Access keys (SSH / HTTP / HTTPS / TELNET / WINRM / ONVIF) require {username, password} and accept optional purpose (DEVICE_MANAGEMENT default, also CONFIGURATION_MANAGEMENT / CUSTOM_DRIVER_MANAGEMENT / OS_MANAGEMENT). When purpose=CUSTOM_DRIVER_MANAGEMENT you MUST also pass driver_id. SNMP variants: SNMPv1/SNMPv2 require community (optional write_community); SNMPv3_NO_AUTH requires username; SNMPv3_AUTH_NO_PRIV adds authentication_protocol + authentication_key; SNMPv3_AUTH_PRIV adds encryption_protocol + encryption_key. OVERWRITES the existing credential of the same kind/purpose. Validation is asynchronous on the collector — re-fetch with get_device_credentials after a few seconds. If the collector is unreachable the call returns result=CREDENTIALS_SAVED_VALIDATION_TIMEOUT — credentials are saved, retry later. Never include secrets in any user-visible message. For SNMP credentials specifically, when the client renders HTML UI (Claude Desktop, Claude.ai web), prefer get_snmp_credentials_form for a guided form-based flow; this tool remains the canonical text alternative.Input Parameters
Output
Set device power
Set device power
DOMOTZ_MCP_SET_DEVICE_POWERChange the power state of a device: turn it on, hold it off, cycle it, or issue a software_reboot. on/off/cycle act on the outlet of the PoE switch or PDU the device is plugged into; software_reboot is a management command sent to the device itself. Unlike cycle, an off is durable — the device stays powered off until an explicit on, so a Power Off / wait / Power On sequence is two calls. The call is asynchronous (HTTP 202): the response confirms DISPATCH, not completion — re-query device_inventory or get_uptime to confirm the outcome. obi pre-checks the device’s power capabilities and returns NOT_SUPPORTED with a reason instead of dispatching when the requested action is unavailable. Address the device by its own device_id: the host device and outlet are resolved for you.Input Parameters
Output
Set interfaces policy
Set interfaces policy
DOMOTZ_MCP_SET_INTERFACES_POLICYSet which of the collector’s own network interfaces take part in discovery, by name. Rules are interface-name patterns where * is the only wildcard (e.g. ‘eth0’, ‘docker*’, ‘br-*’); matching is case-insensitive. This REPLACES the current policy - send the full set of rules you want, not a delta.- policy=‘deny’ with rules: every interface is scanned EXCEPT the ones matching. This is how you stop the collector scanning a noisy or irrelevant interface (a container bridge, a VPN tunnel).
- policy=‘deny’ with no rules: the default - every interface is scanned.
- policy=‘allow’ with rules: ONLY matching interfaces are scanned.
- policy=‘allow’ with no rules: nothing at all is scanned, so no device is discovered or monitored on any subnet. Rejected here as it is almost never intended. At most 10 rules, each at most 20 characters. Use
get_network_configurationfirst: it lists the collector’s actual interface names and the policy in force.
Input Parameters
Output
Snooze collector alerts
Snooze collector alerts
DOMOTZ_MCP_SNOOZE_COLLECTOR_ALERTSSnooze (temporarily mute) all alerting for a collector for a maintenance window. Equivalent to ‘Snooze Agent Alerts’ in the UI: alerting is suppressed now and automatically resumes when the window ends. Specify the window with EITHER until (an absolute ISO 8601 timestamp, e.g. ‘2026-07-01T18:30:00Z’) OR duration_minutes (a relative number of minutes from now) - provide exactly one. Snoozing is a collector-level maintenance window and applies to the whole collector (individual devices cannot be snoozed); use unsnooze_collector_alerts to resume alerting before the window ends.Input Parameters
Output
Submit feedback
Submit feedback
DOMOTZ_MCP_SUBMIT_FEEDBACKSubmit feedback about a gap in available MCP tools or data. Use this ONLY when you searched for a tool but could not find one, got incomplete results from an existing tool, or a tool was missing a needed parameter. Required: what_i_needed, what_i_tried, gap_type. gap_type must be one of: missing_tool, incomplete_results, missing_parameter, wrong_format, other.Input Parameters
Output
Unbind alert rule from collector
Unbind alert rule from collector
DOMOTZ_MCP_UNBIND_ALERT_RULE_FROM_COLLECTORUnbind an alert rule from a collector. Removes the bindings of all of the collector’s variables to the rule — the rule definition itself stays. Use after bind_alert_rule_to_collector or to clean up a rule that is no longer relevant for the collector. Idempotent: unbinding a rule that is not bound returns status=NOT_FOUND (no error).Input Parameters
Output
Unbind alert rule from device
Unbind alert rule from device
DOMOTZ_MCP_UNBIND_ALERT_RULE_FROM_DEVICEUnbind an alert rule from a device. Removes the bindings of all of the device’s variables to the rule — the rule definition itself stays. Use after bind_alert_rule_to_device or to clean up a rule that is no longer relevant for the device. Idempotent: unbinding a rule that is not bound returns status=NOT_FOUND (no error).Input Parameters
Output
Unbind collector from organization
Unbind collector from organization
Unsnooze collector alerts
Unsnooze collector alerts
Update alert rule
Update alert rule
DOMOTZ_MCP_UPDATE_ALERT_RULEUpdate an existing alert rule in place, preserving its device/collector/variable bindings and alert history (unlike deleting and recreating). Only the fields you pass are changed; omitted fields keep their current value. Editable fields: name, severity (Critical / High / Warning / Info), function (a name like ‘GREATER_THAN’ or a numeric function_id), operands, operands_unit, and channel_ids (the full set of notification channels the rule should use; channels not listed are detached, so an empty list is rejected). When changing function, call list_metric_functions first to confirm the valid functions and their required operand count. The rule’s target metric is IMMUTABLE and cannot be changed here: retarget by deleting the rule and creating a new one. Use list_alert_rules to discover valid IDs. Updating a non-existent rule returns status=NOT_FOUND (no error).Input Parameters
Output
Update collector metadata
Update collector metadata
DOMOTZ_MCP_UPDATE_COLLECTOR_METADATAUpdate editable metadata on a collector (the on-site monitoring agent). Editable fields: name (the collector’s display name), time_zone (an IANA time zone such as ‘Europe/Rome’), and the postal address fields address (street address), city, state, country, post_code. This is a partial update: only the fields you pass are changed, the rest are left untouched. Pass at least one field — empty calls are rejected. Use search_collectors to find the collector_id.Input Parameters
Output
Update collector settings
Update collector settings
DOMOTZ_MCP_UPDATE_COLLECTOR_SETTINGSChange how a collector monitors and what it scans: the scope of its device discovery, whether the scheduled scan of the site’s public IP for open TCP ports runs, the periodic ping of managed devices, and whether it exposes the devices’ local web interfaces. This is a partial update - only the fields you pass are changed. Pass at least one; empty calls are rejected.broadcast_discovery: the collector’s device discovery, the ‘Auto Discovery’ switch of the web app (reported asbroadcast_discoverybyget_network_configuration). OFF, the collector stops sweeping its subnets and only probes the addresses already known to the cloud: a new device is never discovered, and a known device that gets a different IP from DHCP simply goes offline. ONVIF, SSDP/UPnP, mDNS and IP-conflict detection stop with it; external hosts keep being probed. Turning it off is how you stop discovery on a site; nothing already monitored is deleted.dhcp_device_discovery: reports devices seen asking for a DHCP lease but never answering a scan (they appear with no IP). It only reports while the discovery above is on, so turning discovery off turns this off too, exactly as the web app does.scan_all_interface_ips: ON, every address of each network interface defines a subnet to scan; OFF, only the first one does, so secondary addresses and VLAN sub-interfaces are never scanned.tcp_open_port_scanner: the scheduled scan of the site’s public IP for open TCP ports. Requires the security feature on the plan: without it the tool answerserror=FEATURE_NOT_AVAILABLEand that setting is not changed.round_trip_delay_monitoring: the collector’s periodic ping of its managed devices to measure latency (round trip delay) and packet loss, with all traffic originating from the collector. OFF, that periodic ping stops and no new latency or packet-loss samples are collected.local_web_interface: whether the collector exposes the devices’ local web interfaces. Changing this RESTARTS the collector, so it briefly goes offline and resumes monitoring once it is back up. Each setting is a separate backend write, applied in a fixed order. If one is refused the tool stops there and reportsupdated(what was applied), the setting that failed, andnot_attempted- so a partial result is never reported as a success. Read the current values back withget_network_configuration(the discovery scope) andcollector_overview(the TCP port scanner, the round trip delay monitoring, and the local web interface).
Input Parameters
Output
Update contact
Update contact
Update device metadata
Update device metadata
DOMOTZ_MCP_UPDATE_DEVICE_METADATAUpdate editable metadata fields on a device: name, importance (important or not important), zone, room, serial, notes (max 256 chars). To clear a field, pass the sentinel value "__clear__" (passing an empty string also works but may be dropped by some clients). Tags can be managed with add_tag_ids / remove_tag_ids. Per-field outcomes are reported in the response so partial successes are visible. Pass at least one field — empty calls are rejected.Input Parameters
Output
Update device monitoring state
Update device monitoring state
DOMOTZ_MCP_UPDATE_DEVICE_MONITORING_STATEManage or unmanage one or more devices by changing their monitoring state. This is the ONLY way to manage or unmanage devices. When the user asks to ‘manage’, ‘start monitoring’, ‘add to monitoring’, or ‘enable monitoring’ for devices, use this tool with monitoring_state=‘managed’. When they ask to ‘unmanage’, ‘stop monitoring’, ‘remove from monitoring’, or ‘disable monitoring’, use monitoring_state=‘unmanaged’. Accepts a single device_id (int) or a list of device_ids (list[int]) for bulk operations — all devices must belong to the same collector. Managed devices consume a licence slot and are actively monitored (alerts, uptime tracking, etc.); unmanaged devices are visible in the network inventory but not actively monitored. IMPORTANT: monitoring_state (managed/unmanaged) is NOT the same as importance (important/not important). They are independent properties. ‘not important’ means low-priority, ‘unmanaged’ means not monitored at all. When the result is LIMIT_EXCEEDED and a checkout_url is present, always ask the user if they want to see the upgrade link — do not silently discard it. Fails with LOCATION_BASED_LICENSING when the collector uses location-based licensing (all devices are automatically monitored). Use search_devices to check the current monitoring_state before calling this tool.Input Parameters
Output
Update device profile
Update device profile
DOMOTZ_MCP_UPDATE_DEVICE_PROFILERenames or re-describes an existing device profile. Only the fields you supply are changed; anything omitted is left as it is, so this is safe to call with just one of them. It does not touch the profile’s contents - the sensors and credentials it applies are unaffected. Use list_device_profiles to find the profile_id.Input Parameters
Output
Update organization
Update organization
DOMOTZ_MCP_UPDATE_ORGANIZATIONUpdate an existing Organization by its internal id. Only the fields you pass are changed (omit a field to leave it untouched). Updating just the name will not clear the organization_id. organization_id is the caller-facing reference (organa’s external_reference).Input Parameters
Output
Update tag
Update tag
DOMOTZ_MCP_UPDATE_TAGRename an existing user-defined tag, change its colour, or both. This is a partial update: omit a field to leave it untouched, and pass at least one — empty calls are rejected. color is cosmetic and user-visible, so change it only when the user asked for a specific colour; valid values are in the color enum. Devices and collectors already carrying the tag keep it; only its name and colour change. A name already used by another tag returns ALREADY_EXISTS. Use list_tags to discover valid IDs. Requires the manage_device_tags permission.