@owine/unifi-protect-mcp 3.0.0 → 3.2.0

package/dist/tools/device-actions.js

@@ -84,6 +84,25 @@ function registerDeviceActionTools(server, client, readOnly) {
         const data = await client.post((0, url_js_1.safePath) `/speakers/${id}/test-sound`, body);
         return (0, responses_js_1.formatSuccess)(data);
     });
+    server.registerTool("protect_stop_speaker_siren", {
+        description: "Stop a siren playing on a speaker. Requires confirm: true: it silences an alarm siren. Returns HTTP 400 if the speaker is offline or its firmware is too old for sirens.",
+        inputSchema: {
+            id: (0, params_js_1.resourceId)().describe("Speaker ID"),
+            confirm: STOP_SIREN.input,
+            dryRun: (0, safety_js_1.dryRunInput)(),
+        },
+        annotations: safety_js_1.DESTRUCTIVE,
+    }, async ({ id, confirm, dryRun }) => {
+        const path = (0, url_js_1.safePath) `/speakers/${id}/stop-siren`;
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("POST", path);
+        }
+        const denied = STOP_SIREN.check(confirm);
+        if (denied)
+            return denied;
+        const data = await client.post(path);
+        return (0, responses_js_1.formatSuccess)(data);
+    });
     // --- Relays ---
     server.registerTool("protect_activate_relay_output", {
         description: "Control a relay output. Relays commonly drive gates, door strikes and garage doors, so this requires confirm: true. state (\"on\"/\"off\") is required: the API's toggle mode is not exposed because a retried toggle would flip the output back. Read the current output state with protect_get_relay. When state is \"on\", pulseDuration auto-turns off after the given milliseconds.",

package/dist/tools/devices.js

@@ -24,7 +24,7 @@ const DEVICES = [
         plural: "lights",
         label: "Light",
         hint: "Known fields: name (string), isLightForceEnabled (boolean), lightModeSettings (object with mode, enableAt), lightDeviceSettings (object with isIndicatorEnabled, pirDuration, pirSensitivity, ledLevel)",
-        returns: "id, modelKey, name, mac, state, type, guid, lightModeSettings (mode, enableAt), lightDeviceSettings (isIndicatorEnabled, pirDuration, pirSensitivity, ledLevel), isDark, isLightOn, isLightForceEnabled, lastMotion, isPirMotionDetected, camera (7.3.70 docs)",
+        returns: "id, modelKey, name, mac, state, type, guid, lightModeSettings (mode, enableAt), lightDeviceSettings (isIndicatorEnabled, pirDuration, pirSensitivity, ledLevel), isDark, isLightOn, isLightForceEnabled, lastMotion, isPirMotionDetected, camera (7.4.99 docs)",
     },
     {
         urlPath: "sensors",
@@ -33,7 +33,7 @@ const DEVICES = [
         plural: "sensors",
         label: "Sensor",
         hint: "Known fields: name (string), lightSettings / humiditySettings / temperatureSettings (objects: isEnabled, margin, lowThreshold, highThreshold), motionSettings / glassBreakSettings (objects: isEnabled, sensitivity, sensitivityWhenArmed), alarmSettings (object: isEnabled), scheduleMode (\"always\" | \"when_armed\"), armProfileIds (array of up to 32 strings, or null), hasCustomSensitivityWhenArmed (boolean). leakSettings is read-only. Returns HTTP 409 if a setting is not supported by this sensor",
-        returns: "id, modelKey, name, mac, state, type, guid, mountType, featureFlags (temperature, humidity, light, motion, waterLeak, open, tamper, smoke — each {channelCount}), batteryStatus (percentage, isLow), stats (light, humidity, temperature — each {value, status}), lightSettings / humiditySettings / temperatureSettings (isEnabled, margin, lowThreshold, highThreshold), isOpened, openStatusChangedAt, isMotionDetected, motionDetectedAt, motionSettings / glassBreakSettings (isEnabled, sensitivity, sensitivityWhenArmed), scheduleMode, armProfileIds, hasCustomSensitivityWhenArmed, alarmTriggeredAt, alarmSettings, leakDetectedAt, externalLeakDetectedAt, leakSettings (isInternalEnabled, isExternalEnabled), tamperingDetectedAt, wirelessConnectionState (signalState: signalQuality, signalStrength; batteryStatus: percentage, isLow; bridge) (7.3.70 docs)",
+        returns: "id, modelKey, name, mac, state, type, guid, mountType, featureFlags (temperature, humidity, light, motion, waterLeak, open, tamper, smoke — each {channelCount}), batteryStatus (percentage, isLow), stats (light, humidity, temperature — each {value, status}), lightSettings / humiditySettings / temperatureSettings (isEnabled, margin, lowThreshold, highThreshold), isOpened, openStatusChangedAt, isMotionDetected, motionDetectedAt, motionSettings / glassBreakSettings (isEnabled, sensitivity, sensitivityWhenArmed), scheduleMode, armProfileIds, hasCustomSensitivityWhenArmed, alarmTriggeredAt, alarmSettings, leakDetectedAt, externalLeakDetectedAt, leakSettings (isInternalEnabled, isExternalEnabled), tamperingDetectedAt, isMountedIncorrectly, wirelessConnectionState (signalState: signalQuality, signalStrength; batteryStatus: percentage, isLow; bridge) (7.4.99 docs)",
     },
     {
         urlPath: "chimes",
@@ -41,7 +41,7 @@ const DEVICES = [
         plural: "chimes",
         label: "Chime",
         hint: "Known fields: name (string), cameraIds (array of doorbell camera IDs linked to the chime), ringSettings (array of objects: cameraId, volume, ringtoneId, repeatTimes)",
-        returns: "id, modelKey, name, mac, state, type, guid, cameraIds (array of camera IDs), ringSettings (array of objects: cameraId, volume, ringtoneId, repeatTimes) — verified live 7.3.70",
+        returns: "id, modelKey, name, mac, state, type, guid, cameraIds (array of camera IDs), ringSettings (array of objects: cameraId, volume, ringtoneId, repeatTimes) — verified live 7.4.99",
     },
     {
         urlPath: "viewers",
@@ -49,7 +49,7 @@ const DEVICES = [
         plural: "viewers",
         label: "Viewer",
         hint: "Known fields: name (string), liveview (string, liveview ID to display, or null)",
-        returns: "id, modelKey, name, mac, state, type, guid, liveview, streamLimit (7.3.70 docs)",
+        returns: "id, modelKey, name, mac, state, type, guid, liveview, streamLimit (7.4.99 docs)",
     },
     {
         urlPath: "sirens",
@@ -59,7 +59,7 @@ const DEVICES = [
         plural: "sirens",
         label: "Siren",
         hint: "Known fields: name (string), volume (integer 1-100), ledSettings (object with isEnabled boolean)",
-        returns: "id, modelKey, name, mac, state, type, guid, volume, ledSettings (isEnabled), sirenStatus (isActive, activatedAt, duration), connectionType, wirelessConnectionState (signalState: signalQuality, signalStrength; batteryStatus: percentage, isLow; bridge) (7.3.70 docs)",
+        returns: "id, modelKey, name, mac, state, type, guid, volume, ledSettings (isEnabled), sirenStatus (isActive, activatedAt, duration), connectionType, wirelessConnectionState (signalState: signalQuality, signalStrength; batteryStatus: percentage, isLow; bridge) (7.4.99 docs)",
     },
     {
         urlPath: "fobs",
@@ -68,7 +68,7 @@ const DEVICES = [
         plural: "fobs",
         label: "Fob",
         hint: "Known fields: name (string). armControlSettings is not documented as patchable; sending it requires confirm: true",
-        returns: "id, modelKey, name, mac, state, type, guid, awayState, buttonLabels, featureFlags (buttons[], hasKeypad), armControlSettings (enabled, armProfileId, nightProfileId), keypadSettings (beepEnabled, beepVolume), wirelessConnectionState (signalState: signalQuality, signalStrength; batteryStatus: percentage, isLow; bridge) (7.3.70 docs)",
+        returns: "id, modelKey, name, mac, state, type, guid, awayState, buttonLabels, featureFlags (buttons[], hasKeypad), armControlSettings (enabled, armProfileId, nightProfileId), keypadSettings (beepEnabled, beepVolume), wirelessConnectionState (signalState: signalQuality, signalStrength; batteryStatus: percentage, isLow; bridge) (7.4.99 docs)",
     },
     {
         urlPath: "relays",
@@ -76,7 +76,7 @@ const DEVICES = [
         plural: "relays",
         label: "Relay",
         hint: "Known fields: name (string), ledSettings (object with isEnabled boolean)",
-        returns: "id, modelKey, name, mac, state, type, guid, ledSettings (isEnabled), outputs (array of objects: id, name, type, delay, pulseDuration, state, rebootState — id is the outputId for protect_activate_relay_output), inputs (array of objects: id, name, state, actionTrigger, actionType, actionOutputId), wirelessConnectionState (signalState: signalQuality, signalStrength; batteryStatus: percentage, isLow; bridge) (7.3.70 docs)",
+        returns: "id, modelKey, name, mac, state, type, guid, ledSettings (isEnabled), outputs (array of objects: id, name, type, delay, pulseDuration, state, rebootState — id is the outputId for protect_activate_relay_output), inputs (array of objects: id, name, state, actionTrigger, actionType, actionOutputId), wirelessConnectionState (signalState: signalQuality, signalStrength; batteryStatus: percentage, isLow; bridge) (7.4.99 docs)",
     },
     {
         urlPath: "speakers",
@@ -84,7 +84,7 @@ const DEVICES = [
         plural: "speakers",
         label: "Speaker",
         hint: "Known fields: name (string), volume (integer 0-100), micVolume (integer 0-100), isMicEnabled (boolean)",
-        returns: "id, modelKey, name, mac, state, type, guid, volume, micVolume, isMicEnabled, speakerState (status, mode), featureFlags (hasMic) (7.3.70 docs)",
+        returns: "id, modelKey, name, mac, state, type, guid, volume, micVolume, isMicEnabled, speakerState (status, mode), featureFlags (hasMic) (7.4.99 docs)",
     },
     {
         urlPath: "bridges",
@@ -92,7 +92,7 @@ const DEVICES = [
         plural: "bridges",
         label: "Bridge",
         hint: "Known fields: name (string)",
-        returns: "id, modelKey, name, mac, state, type, guid, platform, clients (array of MACs), maxClients (7.3.70 docs)",
+        returns: "id, modelKey, name, mac, state, type, guid, platform, clients (array of MACs), maxClients (7.4.99 docs)",
     },
     {
         urlPath: "link-stations",
@@ -101,7 +101,7 @@ const DEVICES = [
         label: "Link station",
         note: "Link stations are non-alarm-hub gateways (use protect_list_alarm_hubs for alarm hubs).",
         hint: "Known fields: name (string)",
-        returns: "id, modelKey (\"linkstation\"), name, mac, state, type, guid, isAlarmHub, ledSettings (isEnabled), lastEvent, alarmHub (armed, battery, buckboost, connector, cover, deviceTamperStatus (e.g. \"tampered\"), currentMeterChannelStatus, currentMeterStatus, inputPower, poeout, powerMeter, output and input (maps keyed by channel), inputTerminalStatus, outputTerminalStatus, emergencyTerminalStatus, auxiliaryPowerTerminalStatus), threadState (network: status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt) (7.3.70 docs)",
+        returns: "id, modelKey (\"linkstation\"), name, mac, state, type, guid, isAlarmHub, ledSettings (isEnabled), lastEvent, alarmHub (armed, battery, buckboost, connector, cover, deviceTamperStatus (e.g. \"tampered\"), currentMeterChannelStatus, currentMeterStatus, inputPower, poeout, powerMeter, output and input (maps keyed by channel), inputTerminalStatus, outputTerminalStatus, emergencyTerminalStatus, auxiliaryPowerTerminalStatus), threadState (network: status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt) (7.4.99 docs)",
     },
     {
         urlPath: "alarm-hubs",
@@ -109,7 +109,7 @@ const DEVICES = [
         plural: "alarm_hubs",
         label: "Alarm hub",
         hint: "Known fields: name (string)",
-        returns: "id, modelKey (\"linkstation\"), name, mac, state, type, guid, isAlarmHub, ledSettings (isEnabled), lastEvent, alarmHub (armed, battery, buckboost, connector, cover, deviceTamperStatus (e.g. \"tampered\"), currentMeterChannelStatus, currentMeterStatus, inputPower, poeout, powerMeter, output and input (maps keyed by channel), inputTerminalStatus, outputTerminalStatus, emergencyTerminalStatus, auxiliaryPowerTerminalStatus), threadState (network: status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt) (7.3.70 docs)",
+        returns: "id, modelKey (\"linkstation\"), name, mac, state, type, guid, isAlarmHub, ledSettings (isEnabled), lastEvent, alarmHub (armed, battery, buckboost, connector, cover, deviceTamperStatus (e.g. \"tampered\"), currentMeterChannelStatus, currentMeterStatus, inputPower, poeout, powerMeter, output and input (maps keyed by channel), inputTerminalStatus, outputTerminalStatus, emergencyTerminalStatus, auxiliaryPowerTerminalStatus), threadState (network: status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt) (7.4.99 docs)",
     },
 ];
 function registerDeviceCrud(server, client, cfg, readOnly) {

package/dist/tools/external-arm-profiles.d.ts

@@ -0,0 +1,9 @@
+import type { ToolRegistrar } from "./registrar.js";
+import { ProtectClient } from "../client.js";
+/**
+ * Settings that change what the alarm protects, when, or who can disarm it:
+ * a longer delay leaves the site unprotected for longer, and clearing the PIN
+ * lets anyone disarm the profile.
+ */
+export declare const EXTERNAL_ARM_PROFILE_CONFIRM_FIELDS: readonly ["schedule", "alarm_ids", "activation_delay", "deactivation_delay", "pin_code"];
+export declare function registerExternalArmProfileTools(server: ToolRegistrar, client: ProtectClient, readOnly: boolean): void;

package/dist/tools/external-arm-profiles.js

@@ -0,0 +1,182 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXTERNAL_ARM_PROFILE_CONFIRM_FIELDS = void 0;
+exports.registerExternalArmProfileTools = registerExternalArmProfileTools;
+const zod_1 = require("zod");
+const responses_js_1 = require("../utils/responses.js");
+const safety_js_1 = require("../utils/safety.js");
+const url_js_1 = require("../utils/url.js");
+const paging_js_1 = require("../utils/paging.js");
+const params_js_1 = require("../utils/params.js");
+const misc_js_1 = require("../schemas/misc.js");
+/**
+ * Arm profiles of the global Alarm Manager, which Protect 7.4 proxies under
+ * /external/arm-profiles. They are not the local alarm manager's profiles
+ * (arm-profiles.ts): the API passes the alarm manager's snake_case records
+ * through, delays are in seconds rather than milliseconds, and arming is per
+ * profile instead of through one "current" profile. Verified live on 7.4.99:
+ * with the global Alarm Manager on, the local /arm-profiles routes answer 400.
+ */
+/** The longest activation or deactivation delay the API accepts, in seconds. */
+const MAX_DELAY_SECONDS = 3600;
+const AVAILABILITY = "Only available when the console uses the global Alarm Manager (protect_list_nvrs featureFlags.useExternalAlarmManager is true).";
+const delay = (which) => zod_1.z.number().int().min(0).max(MAX_DELAY_SECONDS).describe(`${which} delay in seconds (0-${MAX_DELAY_SECONDS.toString()})`);
+const schedule = zod_1.z
+    .record(zod_1.z.string(), zod_1.z.unknown())
+    .refine((o) => Object.keys(o).length > 0, "schedule must include at least one day")
+    .describe('Weekly schedule keyed by day (sun, mon, tue, wed, thu, fri, sat). Each day is { type: "intervals", entries: [{ start: { hour, minute }, end: { hour, minute } }] }, the shape the 7.4.99 docs show; other day types are not documented.');
+const alarmIds = zod_1.z.array(zod_1.z.string().min(1)).describe("Alarm Manager alarm IDs to associate with the profile");
+const pinCode = zod_1.z.string().describe("PIN code for the profile");
+const RETURNS = "id, title, state (e.g. disarmed, breached), state_set_at, state_promotion_due_at, alarm_ids[], schedule (sun..sat, each {type, entries[{start, end: {hour, minute}}]}), activation_delay, deactivation_delay (seconds), has_pin (the PIN is not returned), active_breach_id, created_at, updated_at, created_by, updated_by (7.4.99 docs)";
+/**
+ * Settings that change what the alarm protects, when, or who can disarm it:
+ * a longer delay leaves the site unprotected for longer, and clearing the PIN
+ * lets anyone disarm the profile.
+ */
+exports.EXTERNAL_ARM_PROFILE_CONFIRM_FIELDS = [
+    "schedule",
+    "alarm_ids",
+    "activation_delay",
+    "deactivation_delay",
+    "pin_code",
+];
+// Each gate's confirm input and handler check share one action text.
+const DELETE_PROFILE = (0, safety_js_1.confirmGate)("delete the external arm profile");
+const DISARM_PROFILE = (0, safety_js_1.confirmGate)("disarm the external arm profile");
+/** The request body: only the fields the caller set. */
+function definedFields(fields) {
+    return Object.fromEntries(Object.entries(fields).filter(([, value]) => value !== undefined));
+}
+function registerExternalArmProfileTools(server, client, readOnly) {
+    server.registerTool("protect_list_external_arm_profiles", {
+        description: `List the global Alarm Manager's arm profiles. ${AVAILABILITY} Returns array; each profile: ${RETURNS}.${paging_js_1.PAGING_NOTE}`,
+        inputSchema: paging_js_1.pagingInput,
+        outputSchema: misc_js_1.externalArmProfileListOutputSchema,
+        annotations: safety_js_1.READ_ONLY,
+    }, async ({ limit, offset }) => {
+        const data = await client.get("/external/arm-profiles");
+        return (0, responses_js_1.formatSuccess)((0, paging_js_1.pageOf)(data, limit, offset));
+    });
+    server.registerTool("protect_get_external_arm_profile", {
+        description: `Get one of the global Alarm Manager's arm profiles by ID. ${AVAILABILITY} Returns: ${RETURNS}.`,
+        inputSchema: {
+            id: (0, params_js_1.resourceId)().describe("External arm profile ID"),
+        },
+        outputSchema: misc_js_1.externalArmProfileOutputSchema,
+        annotations: safety_js_1.READ_ONLY,
+    }, async ({ id }) => {
+        const data = await client.get((0, url_js_1.safePath) `/external/arm-profiles/${id}`);
+        return (0, responses_js_1.formatSuccess)(data);
+    });
+    if (readOnly)
+        return;
+    server.registerTool("protect_create_external_arm_profile", {
+        description: `Create an arm profile in the global Alarm Manager. ${AVAILABILITY} Returns the created profile.`,
+        inputSchema: {
+            title: zod_1.z.string().min(1).describe("Profile title"),
+            activation_delay: delay("Activation").optional(),
+            deactivation_delay: delay("Deactivation").optional(),
+            schedule: schedule.optional(),
+            alarm_ids: alarmIds.optional(),
+            pin_code: pinCode.nullable().optional(),
+            dryRun: (0, safety_js_1.dryRunInput)(),
+        },
+        outputSchema: misc_js_1.externalArmProfileOutputSchema,
+        annotations: safety_js_1.WRITE,
+    }, async ({ dryRun, ...fields }) => {
+        const body = definedFields(fields);
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("POST", "/external/arm-profiles", body);
+        }
+        const data = await client.post("/external/arm-profiles", body);
+        return (0, responses_js_1.formatSuccess)(data);
+    });
+    server.registerTool("protect_update_external_arm_profile", {
+        description: `Update an arm profile in the global Alarm Manager (partial update via PATCH): omitted fields stay unchanged, and null clears a nullable one. Changing ${exports.EXTERNAL_ARM_PROFILE_CONFIRM_FIELDS.join(", ")} affects alarm coverage and requires confirm: true. ${AVAILABILITY} Returns the updated profile.`,
+        inputSchema: {
+            id: (0, params_js_1.resourceId)().describe("External arm profile ID"),
+            settings: zod_1.z
+                .object({
+                title: zod_1.z.string().min(1).describe("Profile title (cannot be cleared)"),
+                activation_delay: delay("Activation").nullable(),
+                deactivation_delay: delay("Deactivation").nullable(),
+                schedule: schedule.nullable(),
+                alarm_ids: alarmIds.nullable().describe("Alarm IDs to associate; null or [] clears them"),
+                pin_code: pinCode.nullable().describe("PIN code; null clears it"),
+            })
+                .partial()
+                .loose()
+                .refine((o) => Object.keys(o).length > 0, "settings must include at least one field")
+                .describe("Partial profile settings to update"),
+            confirm: (0, safety_js_1.confirmInput)(`change ${exports.EXTERNAL_ARM_PROFILE_CONFIRM_FIELDS.join(", ")}`),
+            dryRun: (0, safety_js_1.dryRunInput)(),
+        },
+        outputSchema: misc_js_1.externalArmProfileOutputSchema,
+        annotations: safety_js_1.DESTRUCTIVE,
+    }, async ({ id, settings, confirm, dryRun }) => {
+        const path = (0, url_js_1.safePath) `/external/arm-profiles/${id}`;
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("PATCH", path, settings);
+        }
+        const denied = (0, safety_js_1.requireConfirmationForFields)(settings, exports.EXTERNAL_ARM_PROFILE_CONFIRM_FIELDS, confirm);
+        if (denied)
+            return denied;
+        const data = await client.patch(path, settings);
+        return (0, responses_js_1.formatSuccess)(data);
+    });
+    server.registerTool("protect_delete_external_arm_profile", {
+        description: `Delete an arm profile from the global Alarm Manager. ${AVAILABILITY} Requires confirm: true.`,
+        inputSchema: {
+            id: (0, params_js_1.resourceId)().describe("External arm profile ID"),
+            confirm: DELETE_PROFILE.input,
+            dryRun: (0, safety_js_1.dryRunInput)(),
+        },
+        annotations: safety_js_1.DESTRUCTIVE,
+    }, async ({ id, confirm, dryRun }) => {
+        const path = (0, url_js_1.safePath) `/external/arm-profiles/${id}`;
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("DELETE", path);
+        }
+        const denied = DELETE_PROFILE.check(confirm);
+        if (denied)
+            return denied;
+        const data = await client.delete(path);
+        return (0, responses_js_1.formatSuccess)(data);
+    });
+    server.registerTool("protect_arm_external_arm_profile", {
+        description: `Arm one of the global Alarm Manager's arm profiles. ${AVAILABILITY} Returns the profile with its new state.`,
+        inputSchema: {
+            id: (0, params_js_1.resourceId)().describe("External arm profile ID"),
+            dryRun: (0, safety_js_1.dryRunInput)(),
+        },
+        outputSchema: misc_js_1.externalArmProfileOutputSchema,
+        annotations: safety_js_1.WRITE,
+    }, async ({ id, dryRun }) => {
+        const path = (0, url_js_1.safePath) `/external/arm-profiles/${id}/actions/arm`;
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("POST", path);
+        }
+        const data = await client.post(path);
+        return (0, responses_js_1.formatSuccess)(data);
+    });
+    server.registerTool("protect_disarm_external_arm_profile", {
+        description: `Disarm one of the global Alarm Manager's arm profiles, leaving what it protects unguarded until it is re-armed; requires confirm: true. ${AVAILABILITY} Returns the profile with its new state.`,
+        inputSchema: {
+            id: (0, params_js_1.resourceId)().describe("External arm profile ID"),
+            confirm: DISARM_PROFILE.input,
+            dryRun: (0, safety_js_1.dryRunInput)(),
+        },
+        outputSchema: misc_js_1.externalArmProfileOutputSchema,
+        annotations: safety_js_1.DESTRUCTIVE,
+    }, async ({ id, confirm, dryRun }) => {
+        const path = (0, url_js_1.safePath) `/external/arm-profiles/${id}/actions/disarm`;
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("POST", path);
+        }
+        const denied = DISARM_PROFILE.check(confirm);
+        if (denied)
+            return denied;
+        const data = await client.post(path);
+        return (0, responses_js_1.formatSuccess)(data);
+    });
+}

package/dist/tools/index.js

@@ -11,6 +11,7 @@ const files_js_1 = require("./files.js");
 const alarm_manager_js_1 = require("./alarm-manager.js");
 const subscriptions_js_1 = require("./subscriptions.js");
 const arm_profiles_js_1 = require("./arm-profiles.js");
+const external_arm_profiles_js_1 = require("./external-arm-profiles.js");
 const users_js_1 = require("./users.js");
 const pos_js_1 = require("./pos.js");
 function registerAllTools(server, client, readOnly) {
@@ -25,6 +26,7 @@ function registerAllTools(server, client, readOnly) {
     (0, files_js_1.registerFileTools)(tools, client, readOnly);
     (0, alarm_manager_js_1.registerAlarmManagerTools)(tools, client, readOnly);
     (0, arm_profiles_js_1.registerArmProfileTools)(tools, client, readOnly);
+    (0, external_arm_profiles_js_1.registerExternalArmProfileTools)(tools, client, readOnly);
     (0, users_js_1.registerUserTools)(tools, client);
     (0, pos_js_1.registerPosTools)(tools, client, readOnly);
 }

package/dist/tools/liveviews.js

@@ -32,7 +32,7 @@ const liveviewBody = zod_1.z
     .loose();
 function registerLiveviewTools(server, client, readOnly) {
     server.registerTool("protect_list_liveviews", {
-        description: "List all live views (camera grid layouts shown on viewers / in the Protect UI). Returns array; each liveview includes (Integration API 7.3.70-verified): id, modelKey, name, isDefault, isGlobal, layout (number, slot count), owner (user ID), slots (array of {cameras: string[], cycleMode, cycleInterval}). NOTE: slots use a `cameras` string-array, not a single `cameraId`." + paging_js_1.PAGING_NOTE,
+        description: "List all live views (camera grid layouts shown on viewers / in the Protect UI). Returns array; each liveview includes (Integration API 7.4.99-verified): id, modelKey, name, isDefault, isGlobal, layout (number, slot count), owner (user ID), slots (array of {cameras: string[], cycleMode, cycleInterval}). NOTE: slots use a `cameras` string-array, not a single `cameraId`." + paging_js_1.PAGING_NOTE,
         inputSchema: paging_js_1.pagingInput,
         outputSchema: misc_js_1.liveviewListOutputSchema,
         annotations: safety_js_1.READ_ONLY,

package/dist/tools/subscriptions.d.ts

@@ -1,5 +1,13 @@
 import type { ToolRegistrar } from "./registrar.js";
 import { ProtectClient } from "../client.js";
+/**
+ * The model keys /subscribe/updates accepts. Verified live on 7.4.99: the
+ * console validates them against exactly this list, case-sensitively, so
+ * "linkStation" works where the resources' own modelKey "linkstation" is
+ * refused. An unknown key opens the socket, sends an error frame and closes it
+ * (code 4500), so they are checked here before connecting.
+ */
+export declare const UPDATE_MODEL_KEYS: readonly ["nvr", "camera", "chime", "light", "viewer", "speaker", "bridge", "sensor", "siren", "fob", "relay", "aiProcessor", "aiPort", "linkStation", "event", "externalArmProfile"];
 /**
  * Each device message carries a full device object, so a busy site can emit
  * enough in 30s to flood the MCP client's context. Stop listening at the cap.

package/dist/tools/subscriptions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MAX_SUBSCRIPTION_TEXT_CHARS = exports.MAX_SUBSCRIPTION_MESSAGES = void 0;
+exports.MAX_SUBSCRIPTION_TEXT_CHARS = exports.MAX_SUBSCRIPTION_MESSAGES = exports.UPDATE_MODEL_KEYS = void 0;
 exports.registerSubscriptionTools = registerSubscriptionTools;
 const zod_1 = require("zod");
 const client_js_1 = require("../client.js");
@@ -13,6 +13,17 @@ const durationSchema = zod_1.z
     .max(30)
     .default(5)
     .describe("Seconds to listen (1-30, default 5)");
+/**
+ * The model keys /subscribe/updates accepts. Verified live on 7.4.99: the
+ * console validates them against exactly this list, case-sensitively, so
+ * "linkStation" works where the resources' own modelKey "linkstation" is
+ * refused. An unknown key opens the socket, sends an error frame and closes it
+ * (code 4500), so they are checked here before connecting.
+ */
+exports.UPDATE_MODEL_KEYS = [
+    "nvr", "camera", "chime", "light", "viewer", "speaker", "bridge", "sensor", "siren",
+    "fob", "relay", "aiProcessor", "aiPort", "linkStation", "event", "externalArmProfile",
+];
 /**
  * Each device message carries a full device object, so a busy site can emit
  * enough in 30s to flood the MCP client's context. Stop listening at the cap.
@@ -175,7 +186,7 @@ function listenResult(data) {
 }
 function registerSubscriptionTools(server, client) {
     server.registerTool("protect_subscribe_devices", {
-        description: `Connect to the device update WebSocket and collect messages for a specified duration (1-30s). Returns {messages, duration, error?, truncated?}; stops early with truncated=true after ${exports.MAX_SUBSCRIPTION_MESSAGES.toString()} messages or ${exports.MAX_SUBSCRIPTION_TEXT_CHARS.toLocaleString("en-US")} characters of JSON, whichever comes first. A connection that fails before any message arrives returns an error. Each message is an envelope {type, item} where item is a device resource carrying id and modelKey (camera, light, sensor, nvr, …). The 7.3.70 docs show type 'add' with the full device object as item; other message types and whether updates carry only changed fields are not documented — inspect the captured messages. Use to detect device state changes or newly adopted devices. Not available over Cloud Connector (api.ui.com).`,
+        description: `Connect to the device update WebSocket and collect messages for a specified duration (1-30s). Returns {messages, duration, error?, truncated?}; stops early with truncated=true after ${exports.MAX_SUBSCRIPTION_MESSAGES.toString()} messages or ${exports.MAX_SUBSCRIPTION_TEXT_CHARS.toLocaleString("en-US")} characters of JSON, whichever comes first. A connection that fails before any message arrives returns an error. Each message is an envelope {type, item} where item is a device resource carrying id and modelKey (camera, light, sensor, nvr, …). The 7.4.99 docs show type 'add' with the full device object as item; other message types and whether updates carry only changed fields are not documented — inspect the captured messages. Use to detect device state changes or newly adopted devices. Not available over Cloud Connector (api.ui.com).`,
         inputSchema: { duration: durationSchema },
         outputSchema: misc_js_1.subscriptionOutputSchema,
         annotations: safety_js_1.READ_ONLY,
@@ -184,7 +195,7 @@ function registerSubscriptionTools(server, client) {
         return listenResult(data);
     });
     server.registerTool("protect_subscribe_events", {
-        description: `Connect to the Protect event WebSocket and collect messages for a specified duration (1-30s). Returns {messages, duration, error?, truncated?}; stops early with truncated=true after ${exports.MAX_SUBSCRIPTION_MESSAGES.toString()} messages or ${exports.MAX_SUBSCRIPTION_TEXT_CHARS.toLocaleString("en-US")} characters of JSON, whichever comes first. A connection that fails before any message arrives returns an error. Each message is an envelope {type: 'add' | 'update', item: {id, modelKey: 'event', type (event kind, e.g. 'ring'), start, end (epoch ms), device (ID of the camera/sensor that raised it)}} (7.3.70 docs). The full set of event kinds and any further event fields are not documented — inspect the captured messages. Not available over Cloud Connector (api.ui.com).`,
+        description: `Connect to the Protect event WebSocket and collect messages for a specified duration (1-30s). Returns {messages, duration, error?, truncated?}; stops early with truncated=true after ${exports.MAX_SUBSCRIPTION_MESSAGES.toString()} messages or ${exports.MAX_SUBSCRIPTION_TEXT_CHARS.toLocaleString("en-US")} characters of JSON, whichever comes first. A connection that fails before any message arrives returns an error. Each message is an envelope {type: 'add' | 'update', item: {id, modelKey: 'event', type (event kind, e.g. 'ring'), start, end (epoch ms), device (ID of the camera/sensor that raised it)}} (7.4.99 docs). The full set of event kinds and any further event fields are not documented — inspect the captured messages. Not available over Cloud Connector (api.ui.com).`,
         inputSchema: { duration: durationSchema },
         outputSchema: misc_js_1.subscriptionOutputSchema,
         annotations: safety_js_1.READ_ONLY,
@@ -192,4 +203,22 @@ function registerSubscriptionTools(server, client) {
         const data = await collectMessages(client, "/subscribe/events", duration);
         return listenResult(data);
     });
+    server.registerTool("protect_subscribe_updates", {
+        description: `Connect to the model update WebSocket for the chosen model keys and collect messages for a specified duration (1-30s). Returns {messages, duration, error?, truncated?}; stops early with truncated=true after ${exports.MAX_SUBSCRIPTION_MESSAGES.toString()} messages or ${exports.MAX_SUBSCRIPTION_TEXT_CHARS.toLocaleString("en-US")} characters of JSON, whichever comes first. A connection that fails before any message arrives returns an error. Each message is an envelope {type, item} where item carries id and modelKey. The 7.4.99 docs show type 'add' with the full object; verified live on 7.4.99, type 'update' carries only the changed fields. The docs say removals are sent too (except for events) and that a message may cover several model IDs, but show neither — inspect the captured messages. Unlike protect_subscribe_devices, this also covers events, external arm profiles (global Alarm Manager) and AI processors/ports, filtered to the keys you pass. Not available over Cloud Connector (api.ui.com).`,
+        inputSchema: {
+            modelKeys: zod_1.z
+                .array(zod_1.z.enum(exports.UPDATE_MODEL_KEYS))
+                .min(1)
+                .describe('Model keys to subscribe to. Note "linkStation" here, although link station resources report modelKey "linkstation".'),
+            duration: durationSchema,
+        },
+        outputSchema: misc_js_1.subscriptionOutputSchema,
+        annotations: safety_js_1.READ_ONLY,
+    }, async ({ modelKeys, duration }) => {
+        // The keys are enum values, so they need no encoding; the console
+        // accepts them comma-separated.
+        const keys = [...new Set(modelKeys)].join(",");
+        const data = await collectMessages(client, `/subscribe/updates?modelKeys=${keys}`, duration);
+        return listenResult(data);
+    });
 }

package/dist/tools/system.js

@@ -14,7 +14,7 @@ function registerSystemTools(server, client) {
         return (0, responses_js_1.formatSuccess)(data);
     });
     server.registerTool("protect_list_nvrs", {
-        description: "Get the NVR (Network Video Recorder) console info. NOTE: despite the name, the Protect Integration API's /nvrs endpoint returns a SINGLE NVR object, not an array. Returns: id, modelKey, name, type (e.g. UNVR-PRO), guid, mac, doorbellSettings (defaultMessageText, defaultMessageResetTimeoutMs, customMessages[], customImages[] (preview, sprite)), armMode (status, armProfileId, armedAt, willBeArmedAt, breachDetectedAt, breachEventCount, breachTriggerEventId, breachEventId).",
+        description: "Get the NVR (Network Video Recorder) console info. NOTE: despite the name, the Protect Integration API's /nvrs endpoint returns a SINGLE NVR object, not an array. Returns: id, modelKey, name, type (e.g. UNVR-PRO), guid, mac, featureFlags (useExternalAlarmManager: true when the global Alarm Manager owns arming, so the external arm-profile tools apply), doorbellSettings (defaultMessageText, defaultMessageResetTimeoutMs, customMessages[], customImages[] (preview, sprite)), armMode (status, armProfileId, armedAt, willBeArmedAt, breachDetectedAt, breachEventCount, breachTriggerEventId, breachEventId).",
         outputSchema: misc_js_1.nvrOutputSchema,
         annotations: safety_js_1.READ_ONLY,
     }, async () => {

package/dist/tools/users.js

@@ -9,7 +9,7 @@ const params_js_1 = require("../utils/params.js");
 const misc_js_1 = require("../schemas/misc.js");
 function registerUserTools(server, client) {
     server.registerTool("protect_list_users", {
-        description: "List all Protect users (filtered by the API key's access permissions). Returns array; each user includes (Integration API 7.3.70-verified): id, modelKey, name, firstName, lastName, email, ucoreUserId. The Integration API does NOT expose roles, permissions, login history, groups, or notification settings." + paging_js_1.PAGING_NOTE,
+        description: "List all Protect users (filtered by the API key's access permissions). Returns array; each user includes (Integration API 7.4.99-verified): id, modelKey, name, firstName, lastName, email, ucoreUserId. The Integration API does NOT expose roles, permissions, login history, groups, or notification settings." + paging_js_1.PAGING_NOTE,
         inputSchema: paging_js_1.pagingInput,
         outputSchema: misc_js_1.userListOutputSchema,
         annotations: safety_js_1.READ_ONLY,
@@ -27,7 +27,7 @@ function registerUserTools(server, client) {
         return (0, responses_js_1.formatSuccess)(data);
     });
     server.registerTool("protect_list_ulp_users", {
-        description: "List UniFi Identity (ULP) users — per the API docs, those with enrolled credentials (NFC cards, fingerprints). Returns array; each ULP user includes (Integration API 7.3.70-verified): id, modelKey, firstName, lastName, fullName, email (empty string for service accounts), status (e.g. ACTIVE). Enrolled-credential detail (NFC cards, fingerprints) is NOT exposed by this API surface." + paging_js_1.PAGING_NOTE,
+        description: "List UniFi Identity (ULP) users — per the API docs, those with enrolled credentials (NFC cards, fingerprints). Returns array; each ULP user includes (Integration API 7.4.99-verified): id, modelKey, firstName, lastName, fullName, email (empty string for service accounts), status (e.g. ACTIVE). Enrolled-credential detail (NFC cards, fingerprints) is NOT exposed by this API surface." + paging_js_1.PAGING_NOTE,
         inputSchema: paging_js_1.pagingInput,
         outputSchema: misc_js_1.ulpUserListOutputSchema,
         annotations: safety_js_1.READ_ONLY,

package/dist/utils/limits.d.ts

@@ -25,9 +25,30 @@ export declare const SERVER_READ_BUFFER_BYTES: number;
 export declare const MAX_ERROR_BODY_BYTES: number;
 /** Protect answers JSON calls quickly; a longer wait means something is wrong. */
 export declare const REQUEST_TIMEOUT_MS = 25000;
+/**
+ * The startup console check. It runs before the stdio handshake, so it must
+ * fail well inside the time an MCP host waits for a server to come up;
+ * otherwise the host times the server out with no reason in its log.
+ */
+export declare const STARTUP_CHECK_TIMEOUT_MS = 10000;
 /**
  * Snapshots and uploads get the longest budget that still ends before the MCP
  * SDK client's default request timeout. It used to equal that timeout, so a
  * slow snapshot always lost the race.
  */
 export declare const BINARY_TIMEOUT_MS: number;
+/**
+ * Rate limiting. Verified live on 7.4.99: the console caps API calls per
+ * second and answers the excess with HTTP 429 and `Retry-After` (in seconds),
+ * which a host's burst of parallel tool calls easily reaches. The 429 body is
+ * the rate limiter's own ({error, windowMs, limit}), sent before the request
+ * reaches Protect, so a rate-limited write was not applied and is retried too.
+ */
+export declare const MAX_RATE_LIMIT_RETRIES = 3;
+/** The wait when a 429 names none: the console's limit window. */
+export declare const DEFAULT_RETRY_AFTER_MS = 1000;
+/**
+ * The longest Retry-After waited out. Longer is a real throttle rather than a
+ * burst, so the 429 is returned instead of holding the tool call.
+ */
+export declare const MAX_RETRY_AFTER_MS = 5000;

package/dist/utils/limits.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BINARY_TIMEOUT_MS = exports.REQUEST_TIMEOUT_MS = exports.MAX_ERROR_BODY_BYTES = exports.SERVER_READ_BUFFER_BYTES = exports.MAX_UPLOAD_BASE64_CHARS = exports.MAX_SNAPSHOT_BYTES = exports.MAX_RESPONSE_BYTES = exports.MAX_RESULT_BYTES = void 0;
+exports.MAX_RETRY_AFTER_MS = exports.DEFAULT_RETRY_AFTER_MS = exports.MAX_RATE_LIMIT_RETRIES = exports.BINARY_TIMEOUT_MS = exports.STARTUP_CHECK_TIMEOUT_MS = exports.REQUEST_TIMEOUT_MS = exports.MAX_ERROR_BODY_BYTES = exports.SERVER_READ_BUFFER_BYTES = exports.MAX_UPLOAD_BASE64_CHARS = exports.MAX_SNAPSHOT_BYTES = exports.MAX_RESPONSE_BYTES = exports.MAX_RESULT_BYTES = void 0;
 const stdio_js_1 = require("@modelcontextprotocol/sdk/shared/stdio.js");
 const protocol_js_1 = require("@modelcontextprotocol/sdk/shared/protocol.js");
 /**
@@ -60,6 +60,12 @@ exports.SERVER_READ_BUFFER_BYTES = stdio_js_1.STDIO_DEFAULT_MAX_BUFFER_SIZE * RE
 exports.MAX_ERROR_BODY_BYTES = 64 * 1024;
 /** Protect answers JSON calls quickly; a longer wait means something is wrong. */
 exports.REQUEST_TIMEOUT_MS = 25_000;
+/**
+ * The startup console check. It runs before the stdio handshake, so it must
+ * fail well inside the time an MCP host waits for a server to come up;
+ * otherwise the host times the server out with no reason in its log.
+ */
+exports.STARTUP_CHECK_TIMEOUT_MS = 10_000;
 /**
  * Time left for the MCP client between our timeout and its own, so the
  * server's error (which names the call, and says whether a write may have
@@ -72,3 +78,18 @@ const CLIENT_TIMEOUT_MARGIN_MS = 15_000;
  * slow snapshot always lost the race.
  */
 exports.BINARY_TIMEOUT_MS = protocol_js_1.DEFAULT_REQUEST_TIMEOUT_MSEC - CLIENT_TIMEOUT_MARGIN_MS;
+/**
+ * Rate limiting. Verified live on 7.4.99: the console caps API calls per
+ * second and answers the excess with HTTP 429 and `Retry-After` (in seconds),
+ * which a host's burst of parallel tool calls easily reaches. The 429 body is
+ * the rate limiter's own ({error, windowMs, limit}), sent before the request
+ * reaches Protect, so a rate-limited write was not applied and is retried too.
+ */
+exports.MAX_RATE_LIMIT_RETRIES = 3;
+/** The wait when a 429 names none: the console's limit window. */
+exports.DEFAULT_RETRY_AFTER_MS = 1_000;
+/**
+ * The longest Retry-After waited out. Longer is a real throttle rather than a
+ * burst, so the 429 is returned instead of holding the tool call.
+ */
+exports.MAX_RETRY_AFTER_MS = 5_000;

package/dist/version.d.ts

@@ -1,6 +1,8 @@
 /**
  * The published package version, reported to MCP clients during initialize.
- * Read at runtime so release-please's package.json bump is the only edit a
- * release needs. Resolves to the package root from both src/ and dist/.
+ * Read at runtime from package.json, which reads 0.0.0-development in the
+ * repo; the release workflow stamps the tag's version into it before packing,
+ * so a published tarball reports its own version. Resolves to the package
+ * root from both src/ and dist/.
  */
 export declare const SERVER_VERSION: string;

package/dist/version.js

@@ -5,7 +5,9 @@ const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 /**
  * The published package version, reported to MCP clients during initialize.
- * Read at runtime so release-please's package.json bump is the only edit a
- * release needs. Resolves to the package root from both src/ and dist/.
+ * Read at runtime from package.json, which reads 0.0.0-development in the
+ * repo; the release workflow stamps the tag's version into it before packing,
+ * so a published tarball reports its own version. Resolves to the package
+ * root from both src/ and dist/.
  */
 exports.SERVER_VERSION = JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(__dirname, "..", "package.json"), "utf8")).version;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owine/unifi-protect-mcp",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "MCP server for UniFi Protect Integration API",
   "main": "dist/index.js",
   "bin": {
@@ -21,9 +21,9 @@
     "lint:fix": "eslint . --fix"
   },
   "engines": {
-    "node": "^22.19.0 || ^24.0.0"
+    "node": "^22.19.0 || ^24.0.0 || ^26.0.0"
   },
-  "packageManager": "pnpm@12.14.0",
+  "packageManager": "pnpm@12.21.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/owine/unifi-protect-mcp.git"
@@ -38,21 +38,21 @@
   "author": "owine",
   "license": "MIT",
   "dependencies": {
-    "@modelcontextprotocol/sdk": "1.32.1",
-    "undici": "8.12.2",
-    "ws": "8.22.0",
+    "@modelcontextprotocol/sdk": "1.32.2",
+    "undici": "8.12.4",
+    "ws": "8.23.0",
     "zod": "4.6.7"
   },
   "devDependencies": {
     "@eslint/js": "10.0.1",
-    "@types/node": "24.19.2",
+    "@types/node": "26.6.6",
     "@types/ws": "8.18.2",
     "@typescript/native": "npm:typescript@7.0.2",
-    "@vitest/coverage-v8": "5.0.5",
-    "eslint": "10.13.0",
+    "@vitest/coverage-v8": "5.1.0",
+    "eslint": "10.15.0",
     "lefthook": "2.2.2",
     "typescript": "npm:@typescript/typescript6@6.0.2",
-    "typescript-eslint": "8.71.2",
-    "vitest": "5.0.5"
+    "typescript-eslint": "8.72.2",
+    "vitest": "5.1.0"
   }
 }