Skip to main content
Glama

get_version

Retrieve the current Home Assistant version number to verify system compatibility and check for available updates.

Instructions

Get the Home Assistant version

Returns: A string with the Home Assistant version (e.g., "2025.3.0")

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The primary handler function for the 'get_version' tool. Registered via @mcp.tool() decorator. Logs execution and delegates to the get_hass_version helper function.
    @mcp.tool()
    @async_handler("get_version")
    async def get_version() -> str:
        """
        Get the Home Assistant version
        
        Returns:
            A string with the Home Assistant version (e.g., "2025.3.0")
        """
        logger.info("Getting Home Assistant version")
        return await get_hass_version()
  • Helper function that implements the core logic: fetches Home Assistant configuration via API and extracts the version string.
    @handle_api_errors
    async def get_hass_version() -> str:
        """Get the Home Assistant version from the API"""
        client = await get_client()
        response = await client.get(f"{HA_URL}/api/config", headers=get_ha_headers())
        response.raise_for_status()
        data = response.json()
        return data.get("version", "unknown")
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses the return type (a string with version) and an example, which is useful behavioral context. However, it lacks details on potential errors, rate limits, or authentication needs, which are gaps for a tool with no annotation coverage.

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?

The description is front-loaded with the core purpose in the first sentence, followed by a concise return value explanation. Every sentence earns its place with no wasted words, making it highly efficient and well-structured.

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?

Given the tool's simplicity (0 params, no output schema, no annotations), the description is mostly complete—it explains what it does and the return format. However, it could be more complete by addressing potential edge cases or errors, slightly reducing the score.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has 0 parameters, and schema description coverage is 100%, so no parameter documentation is needed. The description does not add param info, but this is acceptable given the lack of parameters, warranting a baseline score of 4 as per the rules for 0 params.

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 explicitly states the verb ('Get') and resource ('Home Assistant version'), making the purpose specific and clear. It distinguishes this tool from siblings like 'get_entity' or 'system_overview' by focusing solely on version retrieval, not entities or system status.

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 description implies usage for retrieving the Home Assistant version, which is clear in context. However, it does not explicitly state when to use this tool versus alternatives (e.g., 'system_overview' might include version info) or any exclusions, leaving some ambiguity in sibling differentiation.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/voska/hass-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server