Skip to main content
Glama
Fistacho

ha-nexus-agent

by Fistacho
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Preview a card template config

card_builder_get_card_template
Read-onlyIdempotent

Resolve a built-in template into a full DocumentData config without saving, so you can inspect or edit the card setup before creating it.

Instructions

Resolve one built-in template into a full DocumentData config, without saving anything.

Calls the template's recipe function and, if it returned a recipe shorthand rather than a full DocumentData, runs it through card_builder_build_from_recipe. Makes no call to Home Assistant.

Use when: inspecting or hand-editing a template's config before calling card_builder_create_card yourself. Not for: saving the card directly — use card_builder_make_template_card to skip this step. Returns: the full DocumentData config dict for the template. Errors: {"error": "unknown_template", "name": ..., "known": [...]} when name isn't a known template.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesTemplate name, e.g. 'sensor_hero', from card_builder_list_card_templates.
slotNoOverride the template's default entity-slot name, e.g. 'main' instead of 'entity'. Omit to use the template's default.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.25.1
    • addedInput schema / properties / name / description
      Added value: +"Template name, e.g. 'sensor_hero', from card_builder_list_card_templates."
    • addedInput schema / properties / slot / description
      Added value: +"Override the template's default entity-slot name, e.g. 'main' instead of 'entity'. Omit to use the template's default."
  2. Addedv0.18.1

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, but the description adds real behavioral context beyond them: it explains the internal flow (calls the template's recipe function, may route through card_builder_build_from_recipe), confirms 'Makes no call to Home Assistant', and documents the error shape for unknown templates.

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?

Well front-loaded with the core action in the first line, then cleanly organized under Use when / Not for / Returns / Errors labels. Slightly verbose with some line-wrapping and an implementation detail (the internal recipe function call) that is informative but not essential.

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?

For a read-only preview tool with a full annotation set and an output schema, the description covers everything needed: what it does, when to use it, the alternative for the save path, and the failure mode. Nothing an agent needs to invoke it correctly 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 the schema already documents both 'name' and 'slot' with examples and defaults. The description only references 'name' obliquely in the error section and adds no syntax or format detail beyond the schema, 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 ('Resolve one built-in template into a full DocumentData config, without saving anything') and immediately clarifies the non-persistent nature of the operation. An agent can distinguish it from card_builder_create_card and card_builder_make_template_card 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?

Explicit 'Use when: inspecting or hand-editing a template's config before calling card_builder_create_card yourself' and 'Not for: saving the card directly — use card_builder_make_template_card to skip this step.' Names both the intended context and the sibling alternative with the condition that selects it.

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