Skip to main content
Glama
owine

UniFi Protect MCP

by owine
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Get snapshot

protect_get_snapshot
Read-only

Capture a JPEG snapshot from a UniFi Protect camera by ID. Optionally request 1080p-or-higher quality or use the package channel for doorbell cameras.

Instructions

Get a JPEG snapshot from a camera. Returns a base64-encoded image/jpeg (rendered directly by MCP clients). Use highQuality=true to force a 1080p-or-higher capture; set channel=package to capture from the secondary package camera on doorbells with hasPackageCamera=true. Fails with HTTP 503 when the camera is offline or unreachable. A snapshot too large for one MCP message is refused with an error; try without highQuality.

Input Schema

NameRequiredDescriptionDefault
idYesCamera ID
channelNoCamera channel to capture. Use "package" for cameras with hasPackageCamera=true (defaults to main)
highQualityNoIf true, force a 1080p-or-higher resolution snapshot

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.15.0
    • changedInput schema / properties / highQuality / description
      Previous value: -"If true, request a high-quality snapshot"New value: +"If true, force a 1080p-or-higher resolution snapshot"
    • addedInput schema / properties / id / pattern
      Added value: +"^[A-Za-z0-9_-]{1,64}$"
  2. Changed1 schema field changedv2.7.5
    • addedInput schema / properties / channel
      Added value: +{
+  "description": "Camera channel to capture. Use \"package\" for cameras with hasPackageCamera=true (defaults to main)",
+  "enum": [
+    "main",
+    "package"
+  ],
+  "type": "string"
+}
  3. First observedv2.7.4

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only declare readOnly/destructive/openWorld; the description goes further by disclosing failure modes (HTTP 503 when the camera is offline or unreachable), an oversize-image refusal, and a concrete remediation ('try without highQuality'). It also notes clients render the image directly, so the agent knows what to expect from a read with no output schema.

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?

Four sentences, all front-loaded: what it returns first, then parameter modifiers, then failure modes and recovery. Every sentence carries operational information with no filler.

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 supplies the return contract (base64 JPEG rendered by clients) and covers the error paths an agent must handle. For a read-only snapshot tool with 3 well-documented params, nothing material is missing.

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

Parameters4/5

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

Schema coverage is 100% and each parameter is already documented, so the baseline is 3; the description still adds value by tying highQuality to the 1080p-or-higher guarantee and to the size-refusal behavior, and by restating the package-camera prerequisite. The overlap with the schema keeps it from a full 5.

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?

States a specific verb and resource ('Get a JPEG snapshot from a camera') plus the concrete return payload ('base64-encoded image/jpeg'). This clearly separates it from siblings like protect_get_rtsp_streams (live stream) and protect_get_camera (metadata) without opening their schemas.

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?

Gives clear conditions for the optional parameters (highQuality for 1080p+, channel=package only for cameras with hasPackageCamera=true) and a fallback path when the response is too large. It does not, however, state when to prefer a snapshot over alternatives such as the RTSP stream tool.

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

Deploy Server

Other Tools