Skip to main content
Glama

unifi_protect_get_event_thumbnail

Read-only

Retrieve the still image captured for a UniFi Protect event, writing it to disk or returning it inline for vision analysis. Use the event ID from listed events to fetch the frame that triggered the detection.

Instructions

Fetch the still image Protect captured for an event — the frame that triggered the detection. Writes it to disk and returns the path by default; set output="image" to return it inline for a vision model to look at, which costs a large amount of context. Pass the event's id from unifi_protect_list_events; results showing hasThumbnail: true have one.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
outputNo"file" writes it to disk and returns the path; "image" returns it inline.file
eventIdYesEvent id — the `id` from unifi_protect_list_events. Results with `hasThumbnail: true` have an image; others return 404. A raw `e-…` value from the console's own payload is also accepted.
savePathNoAbsolute path to write the JPEG to. Defaults to a file under UNIFI_PROTECT_SNAPSHOT_DIR. Parent directories are created.
Behavior5/5

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

Beyond the readOnlyHint annotation, the description discloses several important behaviors: it writes to disk by default, can return inline instead, consumes significant context in image mode, returns 404 for missing thumbnails, and creates parent directories for savePath. This is rich and useful behavioral information.

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?

The description is compact and front-loaded: purpose first, then output modes, then input source. Each sentence earns its place, and there is no redundant or vague wording.

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?

With no output schema, the description adequately explains the return behavior: file path by default or inline image. It also covers error conditions, input provenance, and parameter options, making the tool fully understandable for correct invocation.

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

Parameters5/5

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

Schema coverage is 100%, and the description still adds value: it explains that eventId comes from list_events, that hasThumbnail: true indicates an image exists, that output=image costs significant context for vision models, and that savePath parent directories are created. These go beyond the raw schema descriptions.

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 clearly identifies the verb and resource: fetch the still image captured for a Protect event. It distinguishes this from event metadata and from sibling tools like get_camera_snapshot or get_event_thumbnails by specifying the event-triggered still frame.

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?

It gives clear context on when to use the tool: pass an event id from unifi_protect_list_events and prefer events with hasThumbnail: true. It also explains the output=image alternative for vision models. It does not explicitly name sibling alternatives or state when not to use them, but the usage context is strong.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mgcrea/mcp-unifi-protect'

If you have feedback or need assistance with the MCP directory API, please join our Discord server