Skip to main content
Glama
Sign In
homebutler

homebutler

by Higangssh
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Go
Hybrid

inventory_export

Read-only

Export server inventory and topology as a Mermaid diagram or JSON file, locally or from a remote server, to document your homelab setup.

Instructions

Export server inventory/topology as a Mermaid diagram locally, or JSON locally/remotely. Inside a container a local export is refused, because a container cannot see the machine it is on

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": "inventory_export"
  }
}

Input Schema

NameRequiredDescriptionDefault
formatNoExport format: mermaid (default, local) or json
serverNoRemote server name from config (optional; remote supports format=json, and is the only way to export from inside a container)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.8.0
    • changedInput schema / properties / server / description
      Previous value: -"Remote server name from config (optional; remote supports format=json)"New value: +"Remote server name from config (optional; remote supports format=json, and is the only way to export from inside a container)"
  2. Addedv0.18.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds a valuable behavioral fact not in annotations — that a local export is refused inside a container and why — which preempts a predictable failure. It stops short of saying where the exported file lands or what is 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?

Two sentences, front-loaded with the capability and the format options, then the container caveat. The phrasing 'locally, or JSON locally/remotely' is slightly awkward but carries real information without padding.

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

Completeness3/5

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

For an export tool with no output schema, the agent still cannot tell whether the diagram/file is written to disk and where, or returned inline. The container restriction is well covered, but the output destination is a meaningful gap given no output schema exists.

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%, so both parameters are already documented, including the note that remote supports format=json. The description reinforces the local/remote format matrix but adds little syntax or default detail beyond the schema, so the baseline applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb (Export) and resource (server inventory/topology) plus the output formats (Mermaid, JSON), so the agent knows exactly what the tool produces. It does not explicitly distinguish itself from inventory_scan, but the export framing is clear enough on its own.

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?

It gives concrete selection rules: Mermaid is local-only, JSON works locally or remotely, and remote is the only option inside a container. It lacks explicit guidance on when to prefer this over inventory_scan, but the format/transport conditions are actionable.

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