Skip to main content
Glama

serial_status

Read-onlyIdempotent

Read COM1 serial configuration and check whether a serial-console reader is attached, so you can verify guest console access before connecting.

Instructions

Read COM1 configuration and whether this server has an attached serial-console reader.

Input Schema

NameRequiredDescriptionDefault
vm_nameYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is fully covered by structured data. The description adds a useful piece of substance beyond that — it discloses that the result includes whether a serial-console reader is attached — but says nothing about failure modes (e.g., VM not running, COM1 absent) or cost.

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?

A single tight, front-loaded sentence with no filler or redundancy. It is perhaps too short given the unresolved target ambiguity, but there is not a wasted word.

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?

An output schema exists so return values need not be explained, and annotations carry the safety profile, which lowers the burden. However, the meaning of the required vm_name argument and the state in which the call is valid are left unaddressed, leaving a real gap for a one-parameter tool with zero schema coverage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and the single parameter vm_name is never mentioned in the description; 'this server' actively conflicts with a VM-scoped parameter, so an agent cannot tell from the description whether vm_name is a VM identifier or a host. This is precisely the case where the description needed to compensate and did not.

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 and resource ('Read COM1 configuration' plus attached serial-console reader status), which clearly separates it from the mutating siblings serial_connect/serial_send/serial_disconnect. The only weakness is that it says 'this server' without tying the operation to the vm_name parameter, leaving the target slightly ambiguous.

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 statement of when to use this versus serial_connect, debug_serial_status, or console_info, all of which are plausible alternatives in the sibling list. An agent must infer that this is a pre-flight check before connecting, and nothing excludes misuse.

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