Skip to main content
Glama
DustinTrap

kvm-pilot

by DustinTrap

boot_options

Read-onlyIdempotent

Read the host's current Redfish boot override, mode, and allowable boot targets to confirm which boot-device values the BMC will accept before setting one.

Instructions

Show the host's current boot override (Redfish BootSourceOverride) — read-only.

Reports enabled (Disabled/Once/Continuous), the normalized target, the mode (UEFI/Legacy, or null if the BMC doesn't expose it), and the allowable targets the BMC advertises — so an actuator knows what set_boot_device values this box will accept before trying one.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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. Changed1 schema field changedv1.0.0
    • 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.3/5.0
Behavior4/5

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

Annotations already establish readOnlyHint/idempotent/non-destructive, and the description adds real substance beyond them: it enumerates the returned fields, notes that 'mode' may be null when the BMC does not expose it, and that 'allowable' is BMC-advertised. Only the exact return shape/pagination is left unstated, which is 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core purpose and read-only nature are front-loaded in the first clause, followed by a compact enumeration of the returned fields and one forward-looking rationale. No sentence is filler.

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

Completeness5/5

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

There is no output schema, so the description correctly carries the burden of describing return values (enabled, target, mode, allowable) with enough nuance (null mode, advertised allowable) for correct use. Combined with annotations covering safety, nothing essential 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 description coverage is 100% and the single 'profile' parameter is fully documented in the schema, so the description adds nothing about it. Per the high-coverage baseline, a 3 is appropriate for a one-parameter tool that needs no further elucidation.

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?

States a specific verb and resource ('Show the host's current boot override') and names the underlying Redfish property (BootSourceOverride), pinning the concept precisely. It contrasts implicitly with the sibling set_boot_device as the read-side counterpart, so an agent can tell the two apart immediately.

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 a concrete use context: an actuator should consult this before calling set_boot_device to learn which target values the box accepts. That is a clear when-to-use signal, though it does not state explicit exclusions or other alternatives.

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