Skip to main content
Glama

Set an input_boolean value

helpers_set_input_boolean
Idempotent

Set an input_boolean helper to true or false in Home Assistant, updating the chosen entity and returning changed states.

Instructions

Set an input_boolean helper to true or false.

Calls input_boolean.turn_on when value is true, otherwise input_boolean.turn_off, over HTTP.

Use when: setting a known boolean helper to a specific value. Not for: any other domain's on/off state — use entities_turn_on/ entities_turn_off, which work generically across domains including input_boolean. Returns: the list of states changed by the call.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
valueYesTarget boolean value; true calls turn_on, false calls turn_off.
entity_idYesFull input_boolean entity ID to set, e.g. 'input_boolean.guest_mode'.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.25.1
    • addedInput schema / properties / entity_id / description
      Added value: +"Full input_boolean entity ID to set, e.g. 'input_boolean.guest_mode'."
    • addedInput schema / properties / value / description
      Added value: +"Target boolean value; true calls turn_on, false calls turn_off."
  2. First observedv0.3.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description still adds real value beyond the annotations: it discloses the concrete service mapping (turn_on vs turn_off) and that the call goes over HTTP, letting the agent reason about idempotence and side effects. It stops short of discussing permission requirements or failure modes, so not a 5.

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?

Front-loaded with the core action, then structured into rationale, usage, exclusion and return sections. Slightly longer than strictly necessary (the HTTP transport note and the return sentence are marginal), but every line is readable and none are padding-level filler.

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 two-parameter, idempotent setter with a full schema, rich annotations and an output schema, the description covers purpose, routing, mechanics and result. Nothing an agent needs in order to call this 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% and both parameters carry descriptions, so the schema already does the work; the description's true/false-to-turn_on/turn_off mapping merely restates the 'value' schema text. Baseline 3 applies when the schema is fully self-documenting.

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 ('Set an input_boolean helper to true or false') and goes further by naming the exact underlying service calls invoked for each branch. An agent can distinguish this from helpers_set_input_number/text/select and from the generic entity controls without opening any 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?

Has explicit 'Use when' and 'Not for' clauses: it names the alternative tools (entities_turn_on/entities_turn_off) and the condition under which they should be preferred. This is exactly the when/when-not/alternatives guidance the dimension asks for.

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