Skip to main content
Glama

open_port

Opens or reuses a Windows COM port, starts RX capture, and returns an Xshell Telnet endpoint so multiple clients can share serial output without sending text.

Instructions

Open/reuse COMx, start RX capture, return Xshell Telnet endpoint. Never sends text.

Confirm serial parameters with user; driver/hardware may glitch DTR/RTS on open. Existing different settings are rejected, not silently replaced.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "port": "<port>"
    },
    "name": "open_port"
  }
}

Input Schema

NameRequiredDescriptionDefault
dtrNo
rtsNo
portYes
parityNoN
baudrateNo
bytesizeNo
stopbitsNo
flow_controlNonone

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations at all, the description carries the full burden and delivers substantive behavior: it starts RX capture, returns a Telnet endpoint, performs no text transmission, and rejects rather than silently overwrites mismatched settings. The DTR/RTS hardware-glitch warning is exactly the kind of operational caveat annotations could not express. It does not address blocking/timeout behavior or what happens on a busy port, leaving a modest gap.

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?

Three short sentences, front-loaded with the action and its effects, followed by the safety caveat and the conflict rule. Every sentence adds information and none restates the tool name.

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?

For an 8-parameter, no-annotation, no-output-schema tool, the description covers purpose, side effects, and return endpoint well, but leaves most parameters undocumented and does not describe failure modes beyond setting conflicts. Adequate to call correctly in the happy path, thin for edge cases.

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% across 8 parameters, so the description must compensate and largely does not. It hints at the port format ('COMx') and flags that DTR/RTS may glitch on open, but baudrate, parity, bytesize, stopbits, and flow_control receive no explanation of accepted values or defaults, and the 'different settings rejected' rule never says which settings are compared.

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 ('Open/reuse COMx') plus concrete side effects ('start RX capture, return Xshell Telnet endpoint'). The negative clause 'Never sends text' sharply distinguishes it from the send/send_bytes/execute siblings, so an agent can pick it without inspecting other schemas.

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 real precondition ('Confirm serial parameters with user') and clarifies reuse semantics via 'Open/reuse' and the rejection rule for conflicting settings. It stops short of explicitly routing to siblings such as close_port or list_ports, so it is clear context rather than full when/when-not guidance.

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