Skip to main content
Glama

Render a blueprint with given inputs

blueprints_substitute_blueprint
Read-onlyIdempotent

Preview the automation or script a Home Assistant blueprint produces from given inputs before saving, resolving placeholders without storing or reloading.

Instructions

Render a blueprint with given inputs into a plain automation or script.

Calls the blueprint/substitute WebSocket command, which resolves input against the blueprint's input: placeholders and returns the resulting config; nothing is saved or reloaded by this tool.

Use when: previewing the concrete triggers/conditions/actions a blueprint would produce before saving it via automations_set_automation_config or automations_set_script_config. Returns: dict with the substituted automation/script YAML content as a dict. Limits: blocks for the WebSocket round trip; the default 10 second response wait in ha._ws_call applies.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesBlueprint path relative to /config/blueprints/<domain>/ to render, e.g. 'author/blueprint_name.yaml'.
inputYesInput values keyed by the input name declared in the blueprint's own `input:` section.
domainNoBlueprint domain folder `path` lives under, 'automation' or 'script'. Defaults to 'automation'.automation

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.25.1
    • addedInput schema / properties / domain / description
      Added value: +"Blueprint domain folder `path` lives under, 'automation' or 'script'. Defaults to 'automation'."
    • addedInput schema / properties / input / description
      Added value: +"Input values keyed by the input name declared in the blueprint's own `input:` section."
    • addedInput schema / properties / path / description
      Added value: +"Blueprint path relative to /config/blueprints/<domain>/ to render, e.g. 'author/blueprint_name.yaml'."
  2. First observedv0.3.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds genuine context beyond them: the underlying blueprint/substitute command, that inputs resolve against the blueprint's input: placeholders, that nothing is saved or reloaded, and a 10-second WebSocket blocking limit. This is rich behavioral disclosure.

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?

Front-loaded with the action, then labeled sections (Use when, Returns, Limits) make it scannable. Every sentence carries distinct information without 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?

Even though an output schema exists, the description still clarifies return shape, usage context, and runtime limits. For a read-only render/preview tool with nested input objects, nothing essential is missing.

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%, so path/input/domain are fully documented in the schema itself. The description adds only conceptual context about how input maps to placeholders, so the baseline of 3 is appropriate.

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 ('Render') and resource ('a blueprint with given inputs') and specifies the output form ('plain automation or script'). It is clearly distinguishable from sibling config-writers like automations_set_automation_config.

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 provides a 'Use when:' clause (previewing concrete triggers/conditions/actions before saving) and names the exact alternatives (automations_set_automation_config, automations_set_script_config) that apply after this step. The routing condition is unambiguous.

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