rhombus-node-mcp 0.1.43 → 0.1.45

package/dist/api/badge-correlation.js

@@ -0,0 +1,33 @@
+/**
+ * Keystone correlation helper for the OnGuard feature set.
+ *
+ * Given a badge-event-like entry (a camera `deviceUuid` + a `timestampMs`), produce the media hints
+ * the agent needs to *show* the moment: a still (camera-tool `image`) and a short clip window
+ * (clips-tool `createClip`). Pure and reusable — the follow-the-badge timeline, anomaly review, and
+ * lost-badge tracking all turn badge events into "here's the picture/video" the same way.
+ *
+ * Kept deliberately small and side-effect-free. Richer correlation (co-located face events,
+ * people-count in the window) layers on top of this when those features land.
+ */
+export const DEFAULT_CLIP_PADDING_SECONDS = 15;
+/**
+ * Build still + clip hints for a single badge event. Returns empty hints (no clip/still) when the
+ * event lacks a camera or timestamp, so callers can render those events without media gracefully.
+ */
+export function buildMediaHints(event, clipPaddingSeconds = DEFAULT_CLIP_PADDING_SECONDS) {
+    if (!event.deviceUuid || event.timestampMs == null) {
+        return {};
+    }
+    const padMs = Math.max(0, clipPaddingSeconds) * 1000;
+    return {
+        clipHint: {
+            deviceUuid: event.deviceUuid,
+            startTimeMs: event.timestampMs - padMs,
+            endTimeMs: event.timestampMs + padMs,
+        },
+        stillHint: {
+            deviceUuid: event.deviceUuid,
+            timestampMs: event.timestampMs,
+        },
+    };
+}

package/dist/api/badge-timeline-tool-api.js

@@ -0,0 +1,56 @@
+import { buildMediaHints } from "./badge-correlation.js";
+import { searchOnGuardEvents } from "./onguard-tool-api.js";
+/**
+ * Reconstructs a single cardholder's movements as a chronological timeline of OnGuard badge taps,
+ * each with the still/clip hints needed to show what happened. Pure orchestration over
+ * searchOnGuardEvents + the shared correlation helper.
+ */
+export async function getBadgeTimeline(args, timeZone, requestModifiers, sessionId) {
+    const { events } = await searchOnGuardEvents({
+        cardholderQuery: args.cardholderQuery,
+        locationUuids: args.locationUuids,
+        afterMs: args.afterMs,
+        beforeMs: args.beforeMs,
+        limit: args.limit ?? 200,
+    }, timeZone, requestModifiers, sessionId);
+    // searchOnGuardEvents returns newest-first; a timeline reads chronologically.
+    const ordered = events
+        .filter((e) => e.timestampMs != null)
+        .sort((a, b) => (a.timestampMs ?? 0) - (b.timestampMs ?? 0));
+    const stops = ordered.map((e, i) => {
+        const next = ordered[i + 1];
+        const gapToNextSeconds = next?.timestampMs != null && e.timestampMs != null
+            ? Math.round((next.timestampMs - e.timestampMs) / 1000)
+            : undefined;
+        const { clipHint, stillHint } = buildMediaHints({ deviceUuid: e.deviceUuid, timestampMs: e.timestampMs }, args.clipPaddingSeconds);
+        return {
+            timestampMs: e.timestampMs,
+            datetime: e.datetime,
+            deviceUuid: e.deviceUuid,
+            area: e.areaEntering ?? e.areaExiting,
+            label: e.label,
+            isAnomaly: e.isAnomaly,
+            clipHint,
+            stillHint,
+            gapToNextSeconds,
+        };
+    });
+    // The sequence of areas traversed, collapsing consecutive repeats.
+    const path = [];
+    for (const stop of stops) {
+        if (stop.area && stop.area !== path[path.length - 1]) {
+            path.push(stop.area);
+        }
+    }
+    // cardholderQuery is full-text, so it can match more than one person — surface that so the agent
+    // can disambiguate rather than silently merge two people's movements.
+    const distinctCardholders = [
+        ...new Set(ordered.map((e) => e.cardholderName).filter((n) => !!n)),
+    ];
+    return {
+        cardholderName: distinctCardholders[0],
+        ambiguousCardholders: distinctCardholders.length > 1 ? distinctCardholders : undefined,
+        stops,
+        path,
+    };
+}

package/dist/api/onguard-tool-api.js

@@ -0,0 +1,44 @@
+import { postApi } from "../network/network.js";
+import { formatTimestamp } from "../util.js";
+/**
+ * Calls the webservice OnGuard event search (POST /eventSearchV2/searchOnGuardEvents) and maps the
+ * raw seekpoints to an agent-friendly shape. Typed against the generated public OpenAPI schema.
+ */
+export async function searchOnGuardEvents(args, timeZone, requestModifiers, sessionId) {
+    const body = {
+        deviceUuids: args.deviceUuids,
+        locationUuids: args.locationUuids,
+        afterMs: args.afterMs,
+        beforeMs: args.beforeMs,
+        cardholderQuery: args.cardholderQuery,
+        badgeStatus: args.badgeStatus,
+        badgeType: args.badgeType,
+        area: args.area,
+        anomalyOnly: args.anomalyOnly,
+        entryMade: args.entryMade,
+        limit: args.limit ?? 200,
+    };
+    const res = await postApi({
+        route: "/eventSearchV2/searchOnGuardEvents",
+        body,
+        modifiers: requestModifiers,
+        sessionId,
+    });
+    if (res.error) {
+        throw new Error(res.status ?? res.errorMsg ?? "OnGuard event search failed");
+    }
+    const events = (res.events ?? []).map((e) => ({
+        timestampMs: e.timestampMs ?? undefined,
+        datetime: e.timestampMs != null ? formatTimestamp(e.timestampMs, timeZone) : undefined,
+        deviceUuid: e.deviceUuid ?? undefined,
+        label: e.customDisplayName ?? undefined,
+        cardholderName: e.customDescription ?? undefined,
+        badgeStatus: e.badgeStatus ?? undefined,
+        badgeType: e.badgeType ?? undefined,
+        areaEntering: e.areaEntering ?? undefined,
+        areaExiting: e.areaExiting ?? undefined,
+        entryMade: e.entryMade ?? undefined,
+        isAnomaly: e.alert ?? undefined,
+    }));
+    return { events };
+}

package/dist/tools-console/badge-timeline-tool.js

@@ -0,0 +1,50 @@
+import { getBadgeTimeline } from "../api/badge-timeline-tool-api.js";
+import { OUTPUT_SCHEMA, TOOL_ARGS } from "../types/badge-timeline-tool-types.js";
+import { createToolStructuredContent, extractFromToolExtra } from "../util.js";
+const TOOL_NAME = "badge-timeline-tool";
+const TOOL_DESCRIPTION = `
+Reconstructs one person's movements through a building from their Honeywell OnGuard (Lenel) badge taps.
+Use this for incident reconstruction / "follow the badge" requests, e.g. "reconstruct Eve's movements
+yesterday" or "where did this cardholder go".
+
+Returns the cardholder's badge taps in CHRONOLOGICAL order (oldest first), each with:
+- datetime / timestampMs and the area entered
+- deviceUuid: the camera at that door
+- clipHint (camera + start/end window) and stillHint (camera + timestamp)
+- gapToNextSeconds: time until the next tap (a large gap = unobserved movement between doors)
+plus a "path" array summarizing the areas traversed in order.
+
+Resolve relative times like "yesterday" to ISO 8601 first (use the timestamp tool), then pass
+startTime/endTime. cardholderQuery is a full-text name match; if "ambiguousCardholders" is returned the
+query matched more than one person — ask the user which one before trusting the timeline.
+
+IMPORTANT — to show the movement visually: for each stop (or the key transitions), call the camera-tool
+(requestType "image", cameraUuid = stop.deviceUuid, timestamp = stop.timestampMs) for a still you can see,
+and/or the clips-tool (requestType "createClip", using stop.clipHint) for video. Issue those per-stop
+media calls in PARALLEL, then present the timeline as a chronological narrative.
+`;
+const TOOL_HANDLER = async (args, _extra) => {
+    const { requestModifiers, sessionId } = extractFromToolExtra(_extra);
+    try {
+        const result = await getBadgeTimeline({
+            cardholderQuery: args.cardholderQuery,
+            locationUuids: args.locationUuids ?? undefined,
+            afterMs: args.startTime ? new Date(args.startTime).getTime() : undefined,
+            beforeMs: args.endTime ? new Date(args.endTime).getTime() : undefined,
+            clipPaddingSeconds: args.clipPaddingSeconds ?? undefined,
+            limit: args.limit ?? undefined,
+        }, args.timeZone ?? "UTC", requestModifiers, sessionId);
+        return createToolStructuredContent(result);
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : "Unknown error";
+        return createToolStructuredContent({ error: message });
+    }
+};
+export function createTool(server) {
+    server.registerTool(TOOL_NAME, {
+        description: TOOL_DESCRIPTION,
+        inputSchema: TOOL_ARGS,
+        outputSchema: OUTPUT_SCHEMA.shape,
+    }, TOOL_HANDLER);
+}

package/dist/tools-console/onguard-tool.js

@@ -0,0 +1,55 @@
+import { searchOnGuardEvents } from "../api/onguard-tool-api.js";
+import { OUTPUT_SCHEMA, TOOL_ARGS } from "../types/onguard-tool-types.js";
+import { createToolStructuredContent, extractFromToolExtra } from "../util.js";
+const TOOL_NAME = "onguard-events-tool";
+const TOOL_DESCRIPTION = `
+Searches Honeywell OnGuard (Lenel) badge / access-control events for the organization. Use this to answer
+"who entered WHERE and WHEN" questions, e.g. "who entered the back office yesterday".
+
+Each returned event includes:
+- cardholderName: the person's name
+- deviceUuid: the camera that saw the event
+- timestampMs / datetime: when it happened
+- label: e.g. "OnGuard: Badge Authorized" (a grant) or an anomaly label
+- badgeStatus, badgeType, areaEntering, areaExiting, entryMade, isAnomaly
+
+Filters (all optional): area, locationUuids, deviceUuids, cardholderQuery, badgeStatus, badgeType,
+anomalyOnly, entryMade, startTime, endTime, limit. Resolve relative times like "yesterday" to ISO 8601
+first (use the timestamp tool), then pass startTime/endTime.
+
+IMPORTANT — to show pictures and video of each person so the user can visually identify them: after this
+returns, for each event (or the most relevant ones) call the camera-tool (requestType "image",
+cameraUuid = the event's deviceUuid, timestamp = the event's time) to get a still you can see, and/or the
+clips-tool (requestType "createClip") with a short window around the timestamp for video. Issue those
+per-event media calls in PARALLEL.
+`;
+const TOOL_HANDLER = async (args, _extra) => {
+    const { requestModifiers, sessionId } = extractFromToolExtra(_extra);
+    try {
+        const result = await searchOnGuardEvents({
+            area: args.area ?? undefined,
+            locationUuids: args.locationUuids ?? undefined,
+            deviceUuids: args.deviceUuids ?? undefined,
+            cardholderQuery: args.cardholderQuery ?? undefined,
+            badgeStatus: args.badgeStatus ?? undefined,
+            badgeType: args.badgeType ?? undefined,
+            anomalyOnly: args.anomalyOnly ?? undefined,
+            entryMade: args.entryMade ?? undefined,
+            afterMs: args.startTime ? new Date(args.startTime).getTime() : undefined,
+            beforeMs: args.endTime ? new Date(args.endTime).getTime() : undefined,
+            limit: args.limit ?? undefined,
+        }, args.timeZone ?? "UTC", requestModifiers, sessionId);
+        return createToolStructuredContent(result);
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : "Unknown error";
+        return createToolStructuredContent({ error: message });
+    }
+};
+export function createTool(server) {
+    server.registerTool(TOOL_NAME, {
+        description: TOOL_DESCRIPTION,
+        inputSchema: TOOL_ARGS,
+        outputSchema: OUTPUT_SCHEMA.shape,
+    }, TOOL_HANDLER);
+}

package/dist/types/badge-timeline-tool-types.js

@@ -0,0 +1,75 @@
+import { z } from "zod";
+import { createUuidSchema } from "../types.js";
+import { ISOTimestampFormatDescription } from "../utils/timestampInput.js";
+export const TOOL_ARGS = {
+    cardholderQuery: z
+        .string()
+        .describe('The cardholder (person) to reconstruct, full-text name match, e.g. "Eve" or "Eve Adams".'),
+    locationUuids: z
+        .array(createUuidSchema())
+        .nullable()
+        .describe("Optional: restrict to these Rhombus location UUIDs. Use the location-tool to resolve names."),
+    startTime: z
+        .string()
+        .datetime({ message: "Invalid datetime string. Expected ISO 8601 format.", offset: true })
+        .nullable()
+        .describe("Start of the window (inclusive). " + ISOTimestampFormatDescription),
+    endTime: z
+        .string()
+        .datetime({ message: "Invalid datetime string. Expected ISO 8601 format.", offset: true })
+        .nullable()
+        .describe("End of the window (inclusive). " + ISOTimestampFormatDescription),
+    clipPaddingSeconds: z
+        .number()
+        .nullable()
+        .describe("Seconds of video before/after each badge tap to include in the clip hint (default 15)."),
+    limit: z.number().nullable().describe("Maximum badge taps to include (default 200)."),
+    timeZone: z
+        .string()
+        .nullable()
+        .describe("IANA timezone used to format times, e.g. America/New_York. Defaults to UTC."),
+};
+const TOOL_ARGS_SCHEMA = z.object(TOOL_ARGS);
+const ClipHintSchema = z
+    .object({
+    deviceUuid: z.string(),
+    startTimeMs: z.number(),
+    endTimeMs: z.number(),
+})
+    .describe("Pass to clips-tool createClip to get video of this tap.");
+const StillHintSchema = z
+    .object({
+    deviceUuid: z.string(),
+    timestampMs: z.number(),
+})
+    .describe("Pass to camera-tool (requestType image) to get a still of this tap.");
+export const BadgeTimelineStopSchema = z.object({
+    timestampMs: z.number().optional(),
+    datetime: z.string().optional().describe("Human-readable tap time in the requested timezone."),
+    deviceUuid: z
+        .string()
+        .optional()
+        .describe("The camera at this door. Pass to camera-tool (image) or clips-tool (createClip)."),
+    area: z.string().optional().describe("The area entered (or exited) at this tap."),
+    label: z.string().optional(),
+    isAnomaly: z.boolean().optional().describe("True if this tap was an alerting/anomalous event."),
+    clipHint: ClipHintSchema.optional(),
+    stillHint: StillHintSchema.optional(),
+    gapToNextSeconds: z
+        .number()
+        .optional()
+        .describe("Seconds until the next tap — large gaps are unobserved movement between doors."),
+});
+export const OUTPUT_SCHEMA = z.object({
+    cardholderName: z.string().optional().describe("The resolved cardholder name."),
+    ambiguousCardholders: z
+        .array(z.string())
+        .optional()
+        .describe("Set when the query matched more than one person — disambiguate with the user before trusting the timeline."),
+    stops: z
+        .array(BadgeTimelineStopSchema)
+        .optional()
+        .describe("The cardholder's badge taps in chronological order (oldest first)."),
+    path: z.array(z.string()).optional().describe("Areas traversed, in order (consecutive repeats collapsed)."),
+    error: z.string().optional(),
+});

package/dist/types/onguard-tool-types.js

@@ -0,0 +1,70 @@
+import { z } from "zod";
+import { createUuidSchema } from "../types.js";
+import { ISOTimestampFormatDescription } from "../utils/timestampInput.js";
+export const TOOL_ARGS = {
+    area: z
+        .string()
+        .nullable()
+        .describe('Filter to events whose entered area matches this, e.g. "back office". Full-text match.'),
+    locationUuids: z
+        .array(createUuidSchema())
+        .nullable()
+        .describe("Filter to these Rhombus location UUIDs. Use the location-tool to resolve names to UUIDs."),
+    deviceUuids: z
+        .array(createUuidSchema())
+        .nullable()
+        .describe("Filter to these camera UUIDs (the camera that saw the badge event)."),
+    cardholderQuery: z
+        .string()
+        .nullable()
+        .describe("Match the cardholder's name (full-text), e.g. a person you are looking for."),
+    badgeStatus: z.string().nullable().describe("Filter by badge status, e.g. Active or Lost."),
+    badgeType: z.string().nullable().describe("Filter by badge type."),
+    anomalyOnly: z
+        .boolean()
+        .nullable()
+        .describe("Only return anomaly events: an inactive/lost badge was used, or access was granted but no entry was made (possible tailgating)."),
+    entryMade: z
+        .boolean()
+        .nullable()
+        .describe("Filter by whether access was granted AND entry was actually made."),
+    startTime: z
+        .string()
+        .datetime({ message: "Invalid datetime string. Expected ISO 8601 format.", offset: true })
+        .nullable()
+        .describe("Only events at or after this time (inclusive). " + ISOTimestampFormatDescription),
+    endTime: z
+        .string()
+        .datetime({ message: "Invalid datetime string. Expected ISO 8601 format.", offset: true })
+        .nullable()
+        .describe("Only events at or before this time (inclusive). " + ISOTimestampFormatDescription),
+    limit: z
+        .number()
+        .nullable()
+        .describe("Maximum number of events to return (default 200; the server caps at 1000)."),
+    timeZone: z
+        .string()
+        .nullable()
+        .describe("IANA timezone used to format event times, e.g. America/New_York. Defaults to UTC."),
+};
+const TOOL_ARGS_SCHEMA = z.object(TOOL_ARGS);
+export const OnGuardEventSchema = z.object({
+    timestampMs: z.number().optional(),
+    datetime: z.string().optional().describe("Human-readable event time in the requested timezone."),
+    deviceUuid: z
+        .string()
+        .optional()
+        .describe("The camera that saw this event. Pass to camera-tool (requestType image) or clips-tool (createClip) to get a still/video."),
+    label: z.string().optional().describe('Event label, e.g. "OnGuard: Badge Authorized" or an anomaly label.'),
+    cardholderName: z.string().optional().describe("The cardholder (person) name."),
+    badgeStatus: z.string().optional(),
+    badgeType: z.string().optional(),
+    areaEntering: z.string().optional(),
+    areaExiting: z.string().optional(),
+    entryMade: z.boolean().optional(),
+    isAnomaly: z.boolean().optional().describe("True if this is an alerting/anomalous event."),
+});
+export const OUTPUT_SCHEMA = z.object({
+    events: z.array(OnGuardEventSchema).optional(),
+    error: z.string().optional(),
+});

package/dist/types/zod-schemas.js

@@ -5855,6 +5855,12 @@ const Camera_GetCustomFootageSeekpointsV2WSRequest = z.object({
 });
 const SeekpointType = z.string();
 const SeekpointIndexType = z.object({
+    alert: z.boolean().optional(),
+    areaEntering: z.string().optional(),
+    areaExiting: z.string().optional(),
+    badgeStatus: z.string().optional(),
+    badgeType: z.string().optional(),
+    entryMade: z.boolean().optional(),
     compositComponentUuid: z.string().optional(),
     customDescription: z.string().optional(),
     customDisplayName: z.string().optional(),
@@ -10818,6 +10824,25 @@ const Eventsearch_GetEventSeekpointsWSResponse = z.object({
     errorMsg: z.string().optional(),
     warningMsg: z.string().optional()
 });
+const Eventsearch_SearchOnGuardEventsWSRequest = z.object({
+    afterMs: z.number().int().optional(),
+    anomalyOnly: z.boolean().optional(),
+    area: z.string().optional(),
+    badgeStatus: z.string().optional(),
+    badgeType: z.string().optional(),
+    beforeMs: z.number().int().optional(),
+    cardholderQuery: z.string().optional(),
+    deviceUuids: z.array(z.string()).optional(),
+    entryMade: z.boolean().optional(),
+    limit: z.number().int().optional(),
+    locationUuids: z.array(z.string()).optional()
+});
+const Eventsearch_SearchOnGuardEventsWSResponse = z.object({
+    error: z.boolean().optional(),
+    errorMsg: z.string().optional(),
+    events: z.array(SeekpointIndexType).optional(),
+    warningMsg: z.string().optional()
+});
 const Export_ExportAuditEventsWSRequest = z.object({
     endInterval: z.number().int().optional(),
     excludeActions: z.array(z.string()).optional(),
@@ -21985,6 +22010,8 @@ export const schemas = {
     Eventsearch_VideoFootageWSRequest,
     Eventsearch_GetEventSeekpointsWSRequest,
     Eventsearch_GetEventSeekpointsWSResponse,
+    Eventsearch_SearchOnGuardEventsWSRequest,
+    Eventsearch_SearchOnGuardEventsWSResponse,
     Export_ExportAuditEventsWSRequest,
     Export_ExportClimateEventsWSRequest,
     Export_ExportCountReportsWSRequest,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rhombus-node-mcp",
-  "version": "0.1.43",
+  "version": "0.1.45",
   "description": "MCP server for Rhombus API",
   "keywords": [
     "ai",