@owine/unifi-protect-mcp 2.14.2 → 3.0.0

package/dist/tools/arm-profiles.js

@@ -1,151 +1,154 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ARM_PROFILE_CONFIRM_FIELDS = void 0;
 exports.registerArmProfileTools = registerArmProfileTools;
 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");
-const ACTIVATION_DELAY_VALUES = [0, 60000, 300000, 600000];
+const activationDelay = zod_1.z
+    .union([zod_1.z.literal(0), zod_1.z.literal(60000), zod_1.z.literal(300000), zod_1.z.literal(600000)])
+    .describe("Activation delay in milliseconds. Allowed: 0 (none), 60000 (1m), 300000 (5m), 600000 (10m).");
+const armProfileFields = {
+    name: zod_1.z.string().min(1).max(255).describe("Name of the arm profile"),
+    automations: zod_1.z.array(zod_1.z.string()).describe("List of automation IDs associated with this arm profile"),
+    schedules: zod_1.z
+        .array(zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()))
+        .describe('List of arm schedules, e.g. [{ start: "0 22 * * *", end: "0 6 * * *" }] (cron strings)'),
+    recordEverything: zod_1.z.boolean().describe("Whether to record everything when this arm profile is active"),
+    activationDelay,
+};
+/**
+ * Arm profile settings that change what the alarm protects, and when: a
+ * longer activationDelay leaves the site unprotected for longer after arming,
+ * and recordEverything decides whether an armed site records at all.
+ */
+exports.ARM_PROFILE_CONFIRM_FIELDS = ["schedules", "automations", "activationDelay", "recordEverything"];
+// Each gate's confirm input and handler check share one action text.
+const DELETE_PROFILE = (0, safety_js_1.confirmGate)("delete the arm profile");
+const SET_CURRENT_PROFILE = (0, safety_js_1.confirmGate)("change which arm profile the alarm uses");
+const DISARM = (0, safety_js_1.confirmGate)("disarm the alarm");
 function registerArmProfileTools(server, client, readOnly) {
     server.registerTool("protect_list_arm_profiles", {
-        description: "List all arm profiles (only available when using the local alarm manager — the standalone NVR alarm system, not Protect cloud alerts). Returns array; each profile (7.1.83 docs): id, name, automations[], creator, schedules[], recordEverything, activationDelay (0 | 60000 | 300000 | 600000), createdAt, updatedAt.",
+        description: "List all arm profiles (only available when using the local alarm manager — the standalone NVR alarm system, not Protect cloud alerts). Returns array; each profile (7.3.70 docs): id, name, automations[], creator, schedules[], recordEverything, activationDelay (0 | 60000 | 300000 | 600000), createdAt, updatedAt." + paging_js_1.PAGING_NOTE,
+        inputSchema: paging_js_1.pagingInput,
         outputSchema: misc_js_1.armProfileListOutputSchema,
         annotations: safety_js_1.READ_ONLY,
-    }, async () => {
-        try {
-            const data = await client.get("/arm-profiles");
-            return (0, responses_js_1.formatSuccess)(data);
-        }
-        catch (err) {
-            return (0, responses_js_1.formatError)(err);
-        }
+    }, async ({ limit, offset }) => {
+        const data = await client.get("/arm-profiles");
+        return (0, responses_js_1.formatSuccess)((0, paging_js_1.pageOf)(data, limit, offset));
     });
     if (readOnly)
         return;
     server.registerTool("protect_create_arm_profile", {
         description: "Create a new arm profile. Only available when using local alarm manager.",
         inputSchema: {
-            name: zod_1.z.string().min(1).max(255).describe("Name of the arm profile"),
-            automations: zod_1.z.array(zod_1.z.string()).describe("List of automation IDs associated with this arm profile"),
-            schedules: zod_1.z.array(zod_1.z.record(zod_1.z.string(), zod_1.z.unknown())).describe("List of arm schedules"),
-            recordEverything: zod_1.z.boolean().describe("Whether to record everything when this arm profile is active"),
-            activationDelay: zod_1.z
-                .union([zod_1.z.literal(0), zod_1.z.literal(60000), zod_1.z.literal(300000), zod_1.z.literal(600000)])
-                .describe("Activation delay in milliseconds. Allowed: 0 (none), 60000 (1m), 300000 (5m), 600000 (10m)."),
-            dryRun: zod_1.z.boolean().optional().describe("If true, return what would happen without making changes"),
+            ...armProfileFields,
+            dryRun: (0, safety_js_1.dryRunInput)(),
         },
         outputSchema: misc_js_1.armProfileOutputSchema,
         annotations: safety_js_1.WRITE,
     }, async ({ name, automations, schedules, recordEverything, activationDelay, dryRun }) => {
-        try {
-            const body = { name, automations, schedules, recordEverything, activationDelay };
-            if (dryRun) {
-                return (0, safety_js_1.formatDryRun)("POST", "/arm-profiles", body);
-            }
-            const data = await client.post("/arm-profiles", body);
-            return (0, responses_js_1.formatSuccess)(data);
-        }
-        catch (err) {
-            return (0, responses_js_1.formatError)(err);
+        const body = { name, automations, schedules, recordEverything, activationDelay };
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("POST", "/arm-profiles", body);
         }
+        const data = await client.post("/arm-profiles", body);
+        return (0, responses_js_1.formatSuccess)(data);
     });
     server.registerTool("protect_set_current_arm_profile", {
-        description: "Set the current arm profile to be used when enabling the arm alarm. Only available when using local alarm manager.",
+        description: "Set the current arm profile to be used when enabling the arm alarm. Only available when using local alarm manager. Requires confirm: true: it changes what the alarm protects when armed.",
         inputSchema: {
-            armProfileId: zod_1.z.string().describe("The arm profile ID to set as current"),
-            dryRun: zod_1.z.boolean().optional().describe("If true, return what would happen without making changes"),
+            armProfileId: (0, params_js_1.armProfileId)().describe("The arm profile ID to set as current"),
+            confirm: SET_CURRENT_PROFILE.input,
+            dryRun: (0, safety_js_1.dryRunInput)(),
         },
-        annotations: safety_js_1.WRITE,
-    }, async ({ armProfileId, dryRun }) => {
-        try {
-            const body = { armProfileId };
-            if (dryRun) {
-                return (0, safety_js_1.formatDryRun)("PATCH", "/arm-profiles/settings", body);
-            }
-            const data = await client.patch("/arm-profiles/settings", body);
-            return (0, responses_js_1.formatSuccess)(data);
-        }
-        catch (err) {
-            return (0, responses_js_1.formatError)(err);
+        annotations: safety_js_1.DESTRUCTIVE,
+    }, async ({ armProfileId, confirm, dryRun }) => {
+        const body = { armProfileId };
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("PATCH", "/arm-profiles/settings", body);
         }
+        const denied = SET_CURRENT_PROFILE.check(confirm);
+        if (denied)
+            return denied;
+        const data = await client.patch("/arm-profiles/settings", body);
+        return (0, responses_js_1.formatSuccess)(data);
     });
     server.registerTool("protect_update_arm_profile", {
-        description: "Update an existing arm profile (partial update via PATCH). Only available when using local alarm manager.",
+        description: `Update an existing arm profile (partial update via PATCH). Changing ${exports.ARM_PROFILE_CONFIRM_FIELDS.join(", ")} affects alarm coverage and requires confirm: true. Only available when using local alarm manager.`,
         inputSchema: {
-            id: zod_1.z.string().describe("Arm profile ID"),
+            id: (0, params_js_1.armProfileId)().describe("Arm profile ID"),
             settings: zod_1.z
-                .record(zod_1.z.string(), zod_1.z.unknown())
-                .describe(`Partial arm profile settings. Known fields: name (string 1-255 chars), automations (array of strings), schedules (array of objects), recordEverything (boolean), activationDelay (number, allowed: ${ACTIVATION_DELAY_VALUES.join(", ")})`),
-            dryRun: zod_1.z.boolean().optional().describe("If true, return what would happen without making changes"),
+                .object(armProfileFields)
+                .partial()
+                .loose()
+                .refine((o) => Object.keys(o).length > 0, "settings must include at least one field")
+                .describe("Partial arm profile settings to update"),
+            confirm: (0, safety_js_1.confirmInput)(`change ${exports.ARM_PROFILE_CONFIRM_FIELDS.join(", ")}`),
+            dryRun: (0, safety_js_1.dryRunInput)(),
         },
         outputSchema: misc_js_1.armProfileOutputSchema,
-        annotations: safety_js_1.WRITE,
-    }, async ({ id, settings, dryRun }) => {
-        try {
-            if (dryRun) {
-                return (0, safety_js_1.formatDryRun)("PATCH", (0, url_js_1.safePath) `/arm-profiles/${id}`, settings);
-            }
-            const data = await client.patch((0, url_js_1.safePath) `/arm-profiles/${id}`, settings);
-            return (0, responses_js_1.formatSuccess)(data);
-        }
-        catch (err) {
-            return (0, responses_js_1.formatError)(err);
+        annotations: safety_js_1.DESTRUCTIVE,
+    }, async ({ id, settings, confirm, dryRun }) => {
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("PATCH", (0, url_js_1.safePath) `/arm-profiles/${id}`, settings);
         }
+        const denied = (0, safety_js_1.requireConfirmationForFields)(settings, exports.ARM_PROFILE_CONFIRM_FIELDS, confirm);
+        if (denied)
+            return denied;
+        const data = await client.patch((0, url_js_1.safePath) `/arm-profiles/${id}`, settings);
+        return (0, responses_js_1.formatSuccess)(data);
     });
     server.registerTool("protect_delete_arm_profile", {
-        description: "Delete an arm profile by ID. Only available when using local alarm manager.",
+        description: "Delete an arm profile by ID. Only available when using local alarm manager. Requires confirm: true.",
         inputSchema: {
-            id: zod_1.z.string().describe("Arm profile ID"),
-            dryRun: zod_1.z.boolean().optional().describe("If true, return what would happen without making changes"),
+            id: (0, params_js_1.armProfileId)().describe("Arm profile ID"),
+            confirm: DELETE_PROFILE.input,
+            dryRun: (0, safety_js_1.dryRunInput)(),
         },
         annotations: safety_js_1.DESTRUCTIVE,
-    }, async ({ id, dryRun }) => {
-        try {
-            if (dryRun) {
-                return (0, safety_js_1.formatDryRun)("DELETE", (0, url_js_1.safePath) `/arm-profiles/${id}`);
-            }
-            const data = await client.delete((0, url_js_1.safePath) `/arm-profiles/${id}`);
-            return (0, responses_js_1.formatSuccess)(data);
-        }
-        catch (err) {
-            return (0, responses_js_1.formatError)(err);
+    }, async ({ id, confirm, dryRun }) => {
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("DELETE", (0, url_js_1.safePath) `/arm-profiles/${id}`);
         }
+        const denied = DELETE_PROFILE.check(confirm);
+        if (denied)
+            return denied;
+        const data = await client.delete((0, url_js_1.safePath) `/arm-profiles/${id}`);
+        return (0, responses_js_1.formatSuccess)(data);
     });
     server.registerTool("protect_enable_arm_alarm", {
         description: "Enable the arm alarm using the currently selected arm profile. Only available when using local alarm manager.",
         inputSchema: {
-            dryRun: zod_1.z.boolean().optional().describe("If true, return what would happen without making changes"),
+            dryRun: (0, safety_js_1.dryRunInput)(),
         },
         annotations: safety_js_1.WRITE,
     }, async ({ dryRun }) => {
-        try {
-            if (dryRun) {
-                return (0, safety_js_1.formatDryRun)("POST", "/arm-profiles/enable");
-            }
-            const data = await client.post("/arm-profiles/enable");
-            return (0, responses_js_1.formatSuccess)(data);
-        }
-        catch (err) {
-            return (0, responses_js_1.formatError)(err);
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("POST", "/arm-profiles/enable");
         }
+        const data = await client.post("/arm-profiles/enable");
+        return (0, responses_js_1.formatSuccess)(data);
     });
     server.registerTool("protect_disable_arm_alarm", {
-        description: "Disable the arm alarm. Only available when using local alarm manager.",
+        description: "Disable (disarm) the arm alarm, leaving the site unprotected until it is re-armed; requires confirm: true. Only available when using local alarm manager.",
         inputSchema: {
-            dryRun: zod_1.z.boolean().optional().describe("If true, return what would happen without making changes"),
+            confirm: DISARM.input,
+            dryRun: (0, safety_js_1.dryRunInput)(),
         },
-        annotations: safety_js_1.WRITE,
-    }, async ({ dryRun }) => {
-        try {
-            if (dryRun) {
-                return (0, safety_js_1.formatDryRun)("POST", "/arm-profiles/disable");
-            }
-            const data = await client.post("/arm-profiles/disable");
-            return (0, responses_js_1.formatSuccess)(data);
-        }
-        catch (err) {
-            return (0, responses_js_1.formatError)(err);
+        annotations: safety_js_1.DESTRUCTIVE,
+    }, async ({ confirm, dryRun }) => {
+        if (dryRun) {
+            return (0, safety_js_1.formatDryRun)("POST", "/arm-profiles/disable");
         }
+        const denied = DISARM.check(confirm);
+        if (denied)
+            return denied;
+        const data = await client.post("/arm-profiles/disable");
+        return (0, responses_js_1.formatSuccess)(data);
     });
 }

package/dist/tools/cameras.d.ts

@@ -1,3 +1,3 @@
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { ToolRegistrar } from "./registrar.js";
 import { ProtectClient } from "../client.js";
-export declare function registerCameraTools(server: McpServer, client: ProtectClient, readOnly: boolean): void;
+export declare function registerCameraTools(server: ToolRegistrar, client: ProtectClient, readOnly: boolean): void;