Skip to main content
Glama
Vortitron

home-assistant-mcp

by Vortitron

A camera still as pixels

ha_camera_frame
Read-only

Fetch a Home Assistant camera's current still, downscale it to requested width and height, and return base64 RGB bytes for rendering images in terminal or text-based dashboards.

Instructions

A camera's current still decoded and shrunk to at most width x height pixels, returned as RGB bytes (base64, 3 a pixel, row by row): for a client that draws pictures in text, such as a dashboard pane in a terminal (two pixels a character cell with half blocks). To look at a camera yourself, use ha_camera_image. Through VomeHome the API key needs Cameras ticked under Sensitive devices.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
widthYesMost pixels across.
heightYesMost pixels down.
entity_idYesThe camera entity, e.g. 'camera.front_door'.
instance_idNoOptional: the instance you mean (as listed by vomehome_list_instances). When given, the call is refused if this session is targeting a different home, instead of answering from it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.10.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations cover the safety profile (readOnly, openWorld), so the bar is lower, and the description still adds substantial detail: base64 RGB encoding, 3 bytes per pixel, row-by-row layout, and the credential requirement. It omits error/rate-limit behavior, which keeps it from a 5.

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

Conciseness4/5

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

Purpose is front-loaded and every sentence carries information (format, target consumer, alternative, auth). The nested parentheticals (base64, 3 a pixel, two pixels a character cell) make it dense but not wasteful.

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

Completeness4/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 carries the burden of explaining the return value, and it does so thoroughly (base64 RGB bytes, 3 per pixel, row-major). Combined with the auth note and sibling routing, an agent has what it needs to call 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%, and the schema already documents width, height, entity_id, and instance_id. The description adds the notion of downscaling to at most width x height but no per-parameter semantics beyond that, so the baseline 3 applies.

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: it fetches a camera's current still, decodes it, and shrinks it to at most width x height pixels. It also names the sibling ha_camera_image as the tool for looking at a camera yourself, so an agent can distinguish it without opening either schema.

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

Usage Guidelines5/5

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

Explicitly scopes usage to clients that draw pictures in text (terminal dashboard panes, two pixels per cell with half blocks) and routes the user to ha_camera_image for direct viewing. It also states the VomeHome auth prerequisite (Cameras ticked under Sensitive devices).

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