Skip to main content
Glama

Reset a counter helper

helpers_reset_counter
Idempotent

Reset a Home Assistant counter entity to zero, clearing its runtime value. Use when you need to restart a counter from its initial state.

Instructions

Reset a counter helper's value back to 0.

Calls counter.reset with {"entity_id": entity_id} over HTTP; the counter is runtime UI state, not stored configuration.

Use when: clearing a counter back to its initial value. Not for: increasing it by one — use helpers_increment_counter. Returns: the list of states changed by the call.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_idYesFull counter entity ID to reset, e.g. 'counter.visits'.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.25.1
    • addedInput schema / properties / entity_id / description
      Added value: +"Full counter entity ID to reset, e.g. 'counter.visits'."
  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 mutation (readOnlyHint=false), idempotence, and non-destructiveness, lowering the bar. The description adds genuine context beyond them: the underlying counter.reset call, the fact that the counter is runtime UI state rather than stored config, and that changed states are returned.

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 action, then structured Use when / Not for / Returns blocks that are easy to scan. The HTTP invocation detail is slightly extraneous for an agent but does not bloat the definition.

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 single-parameter mutation tool with annotations covering the safety profile and an output schema covering return values, nothing needed to call it correctly is missing; the runtime-vs-config nuance is a useful bonus.

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 entity_id parameter is fully described there with an example ('counter.visits'). The description only echoes entity_id in the call payload, adding no new format or constraint detail, 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 (reset), resource (counter helper), and outcome (value back to 0). Explicitly distinguishes itself from the sibling helpers_increment_counter, so an agent can route 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?

Contains explicit 'Use when' and 'Not for' clauses, and names the correct alternative ('use helpers_increment_counter') for the excluded case. This is the full when/when-not/alternative pattern.

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