Skip to main content
Glama

snapshot_get_snapshot

Retrieve a filtered, aggregated view of Home Assistant state, including areas, devices, entities, integrations, and config. Control which sections and domains appear, paginate states, and customize summary fields.

Instructions

One-shot aggregated view of HA state, filtered.

include controls which sections appear (defaults to states/areas/devices/entities/integrations). Valid values: states, areas, floors, devices, entities, integrations, config.

domains restricts the states list (e.g. ["light", "climate"]). area_id keeps only states whose entity/device belongs to that area. summary strips state objects to entity_id/state/friendly_name (set False for full attributes).

limit / offset paginate the states list (useful for large setups). state_fields overrides summary — return only these keys per state. Valid: entity_id, state, friendly_name, attributes, last_changed, last_updated.

Returns: {"section_name": [...], ..., "_meta": {...}}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeNo
domainsNo
area_idNo
summaryNo
limitNo
offsetNo
state_fieldsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

With no annotations, the description fully discloses the return format, pagination, and filtering behavior. It does not explicitly state it is read-only, but the name 'snapshot_get' strongly implies no side effects. Additional mention of idempotency or safety would raise the score.

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?

The description is well-structured with bullet points for each parameter, making it easy to scan. It front-loads the purpose. While every sentence adds value, it is slightly verbose; a more concise summary could improve readability.

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?

Despite 7 parameters, the description covers all aspects needed for correct invocation: filtering, pagination, output format. The existence of an output schema reduces the burden, but the description still provides crucial details. It is complete for an agent to use effectively.

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?

The schema coverage is 0%, but the description thoroughly explains all 7 parameters: include (valid values), domains, area_id, summary (effect), limit/offset (pagination), state_fields (valid keys). It adds significant meaning beyond the schema, including defaults and behavioral effects.

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 states it provides a 'one-shot aggregated view of HA state, filtered.' It names the resource (HA state snapshot) and action (get), and the sibling 'snapshot_get_area_snapshot' indicates area-specific vs general, so it distinguishes from siblings.

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?

The description explains when to use this tool by detailing its filtering capabilities and return structure. It implies it's for broad overviews, but lacks explicit 'when not to use' or direct comparison to siblings like 'snapshot_get_area_snapshot'. However, parameter guidance effectively communicates usage context.

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/Fistacho/ha-nexus-agent'

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