Skip to main content
Glama
DustinTrap

kvm-pilot

by DustinTrap

ssh_reachable

Read-onlyIdempotent

Check whether the managed host behind a KVM is reachable over SSH before requesting physical intervention, with optional host override for install-time DHCP addresses.

Instructions

Is the managed host's OS reachable over SSH? (read-only, in-band).

Targets the host behind the KVM (its own ssh_host / KVM_PILOT_SSH_HOST), a different machine from the KVM appliance. Use this to prefer remote recovery before asking a user to physically intervene.

host overrides the profile/env ssh_host at runtime — e.g. an install-time DHCP address the profile can't know until the target boots.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostNoOverride the profile's ssh_host for this call only, e.g. an install-time DHCP address the profile cannot know yet.
profileNoProfile name from ~/.config/kvm-pilot/config.toml selecting which KVM/BMC (and its managed host) this call targets. Omit to use the server's default (KVM_PILOT_PROFILE).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.0.0
    • addedInput schema / properties / host / description
      Added value: +"Override the profile's ssh_host for this call only, e.g. an install-time DHCP address the profile cannot know yet."
    • addedInput schema / properties / profile / description
      Added value: +"Profile name from ~/.config/kvm-pilot/config.toml selecting which KVM/BMC (and its managed host) this call targets. Omit to use the server's default (KVM_PILOT_PROFILE)."
  2. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is lower, but the description adds real value: 'read-only, in-band' and the clarification that it targets a different machine than the KVM appliance, plus the runtime-override behavior of host. It doesn't cover timeout/latency behavior, but that's minor here.

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?

Front-loads the core question, then layers scope, routing guidance, and the host override in a tight structured block. Every sentence carries information, though the host paragraph slightly restates the schema description.

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?

For a read-only reachability probe with full annotation coverage and no output schema, the description is nearly complete: it states the operation, the distinct target machine, and when to prefer it. It could note failure semantics (what an unreachable result implies), but nothing critical for correct invocation is missing.

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 in the schema, establishing the baseline of 3. The description reinforces the host override with a use case (install-time DHCP address), but adds no syntax or format detail beyond the schema.

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?

Opens with a precise question ('Is the managed host's OS reachable over SSH?') that names a specific verb-like operation and resource, and explicitly disambiguates the target as the host *behind* the KVM, distinct from the appliance. This separates it cleanly from siblings like ssh_exec, ssh_discover, and healthcheck.

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?

Gives clear context ('use this to prefer remote recovery before asking a user to physically intervene'), which tells the agent when this probe is the right call. It does not explicitly name when-not or enumerate alternatives (e.g. ssh_discover/ssh_exec), so it stops short of a full routing rationale.

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