Skip to main content
Glama
whoamiTM

bi-mcp

by whoamiTM

bi_get_camera_snapshot

Read-only

Fetch a live JPEG frame from any camera and receive it as base64, ready for the agent to save or compare against maps. Useful for verifying PTZ framing or grabbing a still without alert/clip processing.

Instructions

Fetch a single current JPEG frame from a camera via GET /image/<short>. Returns the image as base64 — the calling agent decides where (if anywhere) to write it to disk. Useful for cross-referencing live camera coverage against spatial maps, verifying PTZ preset framing, or capturing a still without going through the alert/clip pipeline.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rawNoIf true, return the raw Blue Iris JSON instead of the shaped view.
cameraYesCamera short name (e.g. 'SecCam_3'). Required.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.3

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The readOnlyHint annotation already signals safety; the description adds the base64 return format and clarifies that the agent, not the tool, is responsible for writing to disk. This goes beyond the annotation without describing every failure mode.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tightly written sentences lead with the operation and endpoint, then cover output format and use cases. Every phrase adds value and there is no repetition of schema content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only action with no output schema, the description explains the HTTP endpoint, the return encoding (base64), the side-effect behavior, and intended use cases. The agent has enough information to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents 'camera' and 'raw'. The description only reinforces the camera short name through the endpoint template, adding no meaningful semantic information beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a concrete verb ('Fetch'), a specific resource ('a single current JPEG frame from a camera'), and the underlying endpoint, making it easy to distinguish from alert/clip-based siblings like bi_get_alert_image.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Three concrete use cases are given (live-coverage cross-referencing, PTZ preset verification, still capture) and it explicitly frames the tool as an alternative to the alert/clip pipeline. It does not name sibling tools directly, but the guidance is clear enough for an agent to know when to call it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.