Skip to main content
Glama
Sign In
Home Assistant MCP Server

Home Assistant MCP Server

Official
by homeassistant-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Get or Find Scenes

ha_config_get_scene
Read-onlyIdempotent

Retrieve full scene configuration for editing, or list and search scenes by name or attribute values.

Instructions

Get a scene's complete configuration, or list and search scenes without scene_id.

Use ha_search for cross-domain discovery and dependency searches. For ordinary scene discovery, use this tool and pass a returned scene_id back to retrieve the complete entities dict and config_hash for editing (pass that hash to ha_config_set_scene for python_transform updates).

Listing returns compact metadata. Integration-managed scenes have no editable storage config or scene_id. Partial content-search results explicitly report unread configs and are not exhaustive.

EXAMPLES:

  • Get scene: ha_config_get_scene("movie_night")

  • Find scenes: ha_config_get_scene(query="movie")

  • Find attribute values: ha_config_get_scene(query="rainbow", search_in_config=True)

For detailed scene configuration help, use ha_get_skill_guide.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "ha_config_get_scene"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum scenes per page
queryNoFilter scene names or IDs
offsetNoPagination offset
scene_idNoScene storage ID from listing (e.g. 'movie_night') or the scene's entity_id; an entity_id is resolved to the storage ID.
search_in_configNoAlso search full stored scene attribute values within a bounded scan

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv8.6.0
    • addedInput schema / properties / limit
      Added value: +{
+  "default": 20,
+  "description": "Maximum scenes per page",
+  "maximum": 100,
+  "minimum": 1,
+  "type": "integer"
+}
    • addedInput schema / properties / offset
      Added value: +{
+  "default": 0,
+  "description": "Pagination offset",
+  "minimum": 0,
+  "type": "integer"
+}
    • addedInput schema / properties / query
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Filter scene names or IDs"
+}
    • addedInput schema / properties / scene_id / anyOf
      Added value: +[
+  {
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]
    • addedInput schema / properties / scene_id / default
      Added value: +null
    • changedInput schema / properties / scene_id / description
      Previous value: -"Scene identifier (e.g., 'movie_night')"New value: +"Scene storage ID from listing (e.g. 'movie_night') or the scene's entity_id; an entity_id is resolved to the storage ID."
    • removedInput schema / properties / scene_id / type
      Removed value: -"string"
    • addedInput schema / properties / search_in_config
      Added value: +{
+  "default": false,
+  "description": "Also search full stored scene attribute values within a bounded scan",
+  "type": "boolean"
+}
    • removedInput schema / required
      Removed value: -[
-  "scene_id"
-]
  2. First observedv7.14.2

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds real behavior beyond them: listing returns only compact metadata, integration-managed scenes have no editable storage config or scene_id, and config-search results are bounded and explicitly not exhaustive. These are exactly the failure modes an agent would otherwise stumble into.

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 mode split is front-loaded and the guidance, caveats, and examples are cleanly separated into paragraphs. It is denser than strictly necessary — the parenthetical about python_transform updates could be tighter — but every sentence carries routing or behavioral information rather than padding.

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?

An output schema exists, so return-shape exposition is not required, and the description instead spends its budget on the things structure cannot express: the dual get/list mode, the integration-managed edge case, and the non-exhaustive search caveat. Nothing an agent needs to call this correctly or interpret its results 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%, so the baseline is 3, and the description beats it by explaining the purpose of scene_id (retrieving the entities dict and config_hash for editing) and demonstrating search_in_config and query through concrete examples. It stops short of documenting limit/offset semantics, which stay with 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 opening sentence names the exact verb+resource pair and captures both modes ('Get a scene's complete configuration, or list and search scenes without scene_id'), which is a real distinction agents must make. It also explicitly separates itself from ha_search for cross-domain discovery, so the boundary with the most tempting sibling is drawn.

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?

It states when to use this tool ('For ordinary scene discovery, use this tool'), when to use the alternative ('Use ha_search for cross-domain discovery and dependency searches'), and the downstream workflow (pass the returned scene_id and config_hash to ha_config_set_scene for python_transform updates). The closing pointer to ha_get_skill_guide covers the remaining escalation path.

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