Skip to main content
Glama

create_serial_session

Open a serial port session by specifying a device path and optional baud rate, with configurable logging and rotation for session output.

Instructions

Open a serial port session. Device path must start with /dev/tty or /dev/cu. (e.g. /dev/ttyUSB0, /dev/cu.usbserial-XXXX)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
deviceYesSerial device path (must start with /dev/tty or /dev/cu.)
log_fileNoFile path to append all session output. File is created if it doesn't exist.
baud_rateNoBaud rate (default: 9600)
log_max_sizeNoMax log file size in MB before rotation (0 = no rotation, default: 0)
log_max_filesNoMax number of rotated log files to keep (default: 3)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.9.0
    • changedInput schema / properties / device / description
      Previous value: -"Serial device path, e.g. /dev/tty.usbserial-XXXX"New value: +"Serial device path (must start with /dev/tty or /dev/cu.)"
    • addedInput schema / properties / log_file
      Added value: +{
      +  "description": "File path to append all session output. File is created if it doesn't exist.",
      +  "type": "string"
      +}
    • addedInput schema / properties / log_max_files
      Added value: +{
      +  "description": "Max number of rotated log files to keep (default: 3)",
      +  "type": "integer"
      +}
    • addedInput schema / properties / log_max_size
      Added value: +{
      +  "description": "Max log file size in MB before rotation (0 = no rotation, default: 0)",
      +  "type": "integer"
      +}
  2. First observed

TDQS

B3.4/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It explains how to open a session but does not disclose what happens afterward (e.g., how to interact, session lifecycle, error conditions). It lacks critical behavioral context like whether authentication is needed or if multiple sessions can coexist.

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?

Two sentences: one states the purpose, the second provides a constraint and examples. Front-loaded, no unnecessary words, highly 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?

Given 5 parameters, no output schema, and no annotations, the description is adequate for initial use but lacks guidance on session interactions and prerequisites. It tells how to open but not what to expect.

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?

Schema coverage is 100% with descriptions for all 5 parameters. The description adds value by providing concrete examples of device paths and reiterating the constraint, which is more helpful than the schema alone.

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 clearly states the action 'Open a serial port session' and specifies the device path constraint. The name 'create_serial_session' aligns with the purpose. However, it does not distinguish itself from sibling tools like 'create_ssh_session' or 'create_local_session'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides a clear constraint (device path must start with /dev/tty or /dev/cu) and examples. However, it does not specify when to use this tool versus alternatives (e.g., SSH, local sessions).

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