Skip to main content
Glama
Sign In
homebutler

homebutler

by Higangssh
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Go
Hybrid

inventory_scan

Read-only

Scan servers to collect system status, Docker containers, app ports, and system ports for a complete inventory and topology view, locally or over SSH.

Instructions

Collect server inventory/topology including system status, Docker containers, app ports, and system ports

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_scan"
  }
}

Input Schema

NameRequiredDescriptionDefault
serverNoRemote server name from config (optional, runs locally if omitted; inside a container a local call is refused, because a container cannot see the machine it is on)

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, runs locally if omitted)"New value: +"Remote server name from config (optional, runs locally if omitted; inside a container a local call is refused, because a container cannot see the machine it is on)"
  2. Addedv0.18.1

TDQS

B3.3/5.0
Behavior3/5

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

The readOnlyHint=true and destructiveHint=false annotations already establish that this is a safe read operation, and the description is consistent with that. It adds useful scope by naming the inventory domains collected, but does not describe operational traits such as permissions, remote-call requirements, performance characteristics, or return format.

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 a single front-loaded sentence with no filler. Every phrase contributes to defining what is collected, and the list of included inventory domains is efficient.

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?

The description covers the high-level collection scope and is consistent with the read-only annotations, while the schema fully documents the only parameter. However, it leaves gaps around when to choose this tool over overlapping siblings and does not describe the returned inventory structure, which matters because there is no output 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 optional server parameter is already fully documented in the schema, including the local-call refusal behavior inside a container. The description does not add meaning beyond the schema, so the baseline score of 3 is appropriate.

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 states a specific verb and resource: "Collect server inventory/topology" and lists concrete collection targets including system status, Docker containers, app ports, and system ports. It is clear what the tool does, though it does not distinguish itself from overlapping siblings such as inventory_export, docker_list, or open_ports.

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?

There is no explicit guidance on when to use this tool versus alternatives, nor any when-not-to-use conditions or prerequisites. The collection scope implies a usage context, but the description leaves the agent to infer why it should choose inventory_scan over inventory_export, network_scan, or open_ports.

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