Skip to main content
Glama
adrighem

Domoticz MCP Server

by adrighem

get_hardware

Retrieves a list of all hardware and gateways configured in Domoticz, enabling monitoring of connected devices.

Instructions

Get all hardware/gateways configured in Domoticz.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The `get_hardware` MCP tool function. It queries the Domoticz API endpoint `type=command¶m=gethardware` and returns the raw response text containing all configured hardware/gateways.
    @mcp.tool()
    async def get_hardware() -> str:
        """Get all hardware/gateways configured in Domoticz."""
        async with create_client() as client:
            response = await _do_request(client, "GET", f"{DOMOTICZ_API_URL}?type=command¶m=gethardware")
            return response.text
  • The tool is registered as an MCP tool via the `@mcp.tool()` decorator on line 927.
    @mcp.tool()
    async def get_hardware() -> str:
Behavior2/5

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. The description only states the action without mentioning side effects, permissions, performance implications, or return characteristics (e.g., whether results are paginated or sorted). For a simple read operation, this lack of detail reduces transparency.

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?

The description is a single, front-loaded sentence of 7 words. It is concise and wastes no words. However, it could be slightly more informative (e.g., mentioning that the output is a list) without sacrificing brevity, so a perfect score is not warranted.

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 (zero parameters) and the presence of an output schema, the description is complete enough to understand the tool's core functionality. It does not explain the structure of hardware records, but that is covered by the output schema. Additional context comparing this tool to other list tools would improve completeness, but the current level is adequate.

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 coverage is trivially 100%. The description adds no parameter information, but none is needed. As per guidelines, for 0 parameters the baseline is 4 because the description cannot add further meaning beyond indicating no inputs are required.

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 clearly states the tool's purpose: 'Get all hardware/gateways configured in Domoticz.' It specifies a concrete verb ('Get') and resource ('hardware/gateways'), and the context ('configured in Domoticz') differentiates it from sibling tools like get_all_devices or get_scenes. The purpose is unambiguous and distinct.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. There are many 'get_*' sibling tools (e.g., get_all_devices, get_device, get_scenes) but the description does not explain the specific use case for hardware/gateways or mention any prerequisites or limitations. Users must infer usage from the name alone.

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