Skip to main content
Glama

Get Card Builder block schema

card_builder_get_block_schema
Read-onlyIdempotent

Retrieve full schema details for a Card Builder block type, including props, types, defaults, and supported domains, to verify block configuration before writing recipes.

Instructions

Get the full embedded schema for one Card Builder block type.

Looks up block_type in the module-level BLOCK_TYPES constant and adds its style targets from STYLE_TARGETS; makes no call to Home Assistant.

Use when: checking a block's exact prop names, types, defaults, enum values, and supported entity domains before writing a recipe. Returns: {type, category, label, accepts_children, requires_entity, props, notes, supported_domains, style_targets, ...} — the same entry as in BLOCK_TYPES plus style_targets. Errors: {"error": "unknown_block_type", "block_type": ..., "known": [...]} when block_type isn't in the embedded schema.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
block_typeYesBlock type id, e.g. 'block-slider', from card_builder_list_block_types.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.25.1
    • addedInput schema / properties / block_type / description
      Added value: +"Block type id, e.g. 'block-slider', from card_builder_list_block_types."
  2. Addedv0.18.1

TDQS

A4.7/5.0
Behavior5/5

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

Annotations cover safety (readOnly, idempotent, non-destructive, not open-world), and the description adds genuine context beyond them: it explains the internal lookup source (BLOCK_TYPES + STYLE_TARGETS), that no HA call is made, the return shape, and the exact error payload for unknown block types.

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-loads purpose in the first sentence, then a mechanics paragraph, a 'Use when:' line, a Returns line, and an Errors line. No filler sentences; each block carries distinct information.

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?

Though an output schema exists, the description helpfully names the top-level keys an agent will inspect, and it documents the failure mode with a concrete error object. For a read-only lookup tool with one param, nothing needed to call 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 coverage is 100% and the single parameter's description already names the format ('block-slider') and points to card_builder_list_block_types. The description adds no syntax or format detail beyond the schema, so 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 (Get) and resource (full embedded schema for one Card Builder block type) and contrasts with siblings by noting it makes no Home Assistant call, unlike runtime data tools. An agent can distinguish this from card_builder_list_block_types (which lists ids) and card_builder_get_card.

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: checking a block's exact prop names, types, defaults, enum values, and supported entity domains before writing a recipe.' This gives a concrete trigger and ties it to a workflow (recipe authoring) with the sibling procedure implied.

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