Skip to main content
Glama
adrighem

Domoticz MCP Server

by adrighem

get_system_status

Retrieve the current version, build time, and status of your Domoticz home automation instance to ensure proper operation.

Instructions

Get the status of the Domoticz instance (version, build time, etc).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The actual implementation of the 'get_system_status' MCP tool. It queries the Domoticz JSON API with 'getversion' to retrieve system version/build info and returns the raw response.
    @mcp.tool()
    async def get_system_status() -> str:
        """Get the status of the Domoticz instance (version, build time, etc)."""
        async with create_client() as client:
            response = await _do_request(client, "GET", f"{DOMOTICZ_API_URL}?type=command¶m=getversion")
            return response.text
  • The tool is registered via the @mcp.tool() decorator on line 814, which registers it with the FastMCP instance ('mcp') created on line 70.
    @mcp.tool()
    async def get_system_status() -> str:
  • The _do_request helper handles HTTP requests with automatic OAuth token refresh on 401 responses. It's used by get_system_status to make the API call.
    async def _do_request(client: httpx.AsyncClient, method: str, url: str, **kwargs) -> httpx.Response:
        """Perform a request with a single retry on 401 Unauthorized to handle expired tokens."""
        global _oauth_token_cache
        
        try:
            resp = await client.request(method, url, **kwargs)
            if resp.status_code == 401:
                # Token might be expired. Clear cache and retry once.
                _oauth_token_cache = None
                
                # Re-fetch token (this will trigger OAuth flow if needed)
                new_token = await _fetch_oauth_token(force_refresh=True)
                if new_token:
                    # Update headers for the retry
                    if "headers" not in kwargs:
                        kwargs["headers"] = {}
                    kwargs["headers"]["Authorization"] = f"Bearer {new_token}"
                    
                    # Retry the request
                    resp = await client.request(method, url, **kwargs)
            
            resp.raise_for_status()
            return resp
        except httpx.HTTPStatusError as e:
            if e.response.status_code == 401:
                raise Exception("Authentication failed. Please check your credentials or re-authenticate.")
            raise e
Behavior3/5

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

Without annotations, the description carries the burden. It correctly indicates a read-only operation ('Get'), but it does not elaborate on any potential side effects, access requirements, or rate limits. For a simple status tool, this is adequate but not thorough.

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?

A single, clear sentence that conveys the essential purpose. No unnecessary words, and the key information is front-loaded.

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?

The tool has an output schema, so the description does not need to detail return values. It provides a good high-level overview with examples. Slightly more detail (like mentioning it returns hardware info) could improve completeness, but it is sufficient.

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 input schema has zero parameters, so schema description coverage is 100%. The description adds no parameter information, but none is needed. A score of 4 is baseline for a parameterless tool, as no additional value is missing.

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 uses a specific verb ('Get') and resource ('status of the Domoticz instance'), and lists example fields (version, build time). It clearly distinguishes this tool from siblings that deal with devices, scenes, users, or operations.

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

Usage Guidelines3/5

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

No explicit guidance on when to use or when not to use, but the tool's purpose is self-evident and distinct from siblings. However, there is no mention of prerequisites or context, which would be helpful for a comprehensive definition.

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/adrighem/domoticz-mcp'

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