Skip to main content
Glama

Home overview

hive_get_overview
Read-only

Retrieve a one-call snapshot of your Hive home: heating zones, hot water, plugs, lights, sensors, holiday mode, and device alerts like low batteries or offline hardware.

Instructions

A one-call snapshot of the home: every heating zone and TRV zone (current and target temperature, mode, boost, whether it's calling for heat), the hot water, plugs, lights and sensors, holiday mode, and anything that needs attention: low batteries, offline devices and discontinued hardware. A good first call.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "hive_get_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
freshNoAsk Hive again instead of using a reading from the last few seconds (HIVE_CACHE_SECONDS)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.1

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false, and idempotentHint=false, and the description usefully adds the scope of what is returned and that it surfaces low batteries, offline devices, and discontinued hardware. However it never mentions that results may come from a short-lived cache, which is the only plausible reason a read snapshot would be flagged non-idempotent; that behavior lives solely in the parameter schema, leaving a gap for an agent reading the description alone.

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?

It is a single dense sentence of enumerated scope followed by a short, front-loaded recommendation, with no filler or repetition. The main sentence is long and heavily parenthetical, which costs a little parsing clarity but each listed item carries real information about coverage.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description carries the burden of describing return contents and does so comprehensively, covering zones, water, devices, and attention flags. The only meaningful omission is cache/staleness behavior tied to the fresh flag, which matters for a snapshot tool but is at least covered in the schema.

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 the sole parameter (fresh, tied to HIVE_CACHE_SECONDS) is fully documented in the schema, so the baseline of 3 applies. The description adds nothing about the parameter or the caching trade-off between speed and freshness, so it neither helps nor hurts here.

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?

The description states a concrete verb-and-resource pair ("one-call snapshot of the home") and enumerates exactly what the snapshot spans: heating and TRV zones, hot water, plugs, lights, sensors, holiday mode, and attention items. That breadth is what separates it from the narrower sibling getters such as hive_get_heating and hive_get_hot_water, so an agent can tell them apart without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The closing line "A good first call" gives explicit, actionable placement guidance: use this to orient before drilling in. It stops short of naming the granular tools to call afterwards or stating when this snapshot is the wrong choice (e.g. when only one zone's detail is needed), which keeps it out of the top band.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.