Skip to main content
Glama

pio_monitor_list

List open serial monitor sessions with port, baud rate, buffered line count, and next cursor position.

Instructions

List open serial monitor sessions with port, baud, buffered line count, and next cursor.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden. It does disclose what data is returned (port, baud, buffered line count, next cursor), which gives the agent a sense of the output. However, it does not explicitly state that the operation is non-mutating or whether any connection side effects occur. The verb 'List' strongly implies read-only, but the description could be more explicit about safety and lack of side effects.

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, efficient sentence that front-loads the action ('List') and the resource, then enumerates the output fields. No wasted words; every element contributes to understanding what the tool does.

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?

Given there are no parameters and an output schema exists (which presumably details return values), the description is sufficient for an agent to call the tool. It specifies the resource and the key fields. It does not mention preconditions like 'requires an active monitor session', but that is largely implied by the tool's purpose and sibling context.

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

Parameters4/5

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

The tool has zero parameters, and the schema description coverage is 100% (since the schema is empty). There is nothing for the description to add about parameter meaning. Baseline for no-parameter tools is 4, and the description correctly focuses on output rather than inputs.

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?

The description uses a clear verb ('List') and specifies the resource ('open serial monitor sessions') with the exact data returned (port, baud, buffered line count, next cursor). This distinguishes it from sibling tools like pio_monitor_start/stop/read/write, which are actions rather than queries.

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?

The verb 'List' and the noun 'sessions' make it clear this is a read-only query for inspecting active monitor sessions. While it doesn't explicitly name alternatives or state when not to use it, the contrast with action-oriented siblings (start/stop/read/write) implies its role. The guidance is adequate but not explicit about exclusions.

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