Skip to main content
Glama
OpenCyber Harness
by mitkox

oc_serial_read

Read pending bytes from a live serial session with a bounded timeout, returning text, hex, and buffer depth without losing data.

Instructions

Read pending bytes from a live serial session with a bounded timeout; returns text, hexadecimal, and buffer depth without losing bytes.

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": {
      "engagement_id": "<engagement_id>",
      "session_id": "<session_id>"
    },
    "name": "oc_serial_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
timeoutNo
max_bytesNo
session_idYes
engagement_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior4/5

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

Annotations are sparse (readOnlyHint=false, idempotentHint=false, destructiveHint=false), so the description carries real weight. It adds the bounded-timeout behavior, the three return facets, and the key guarantee that bytes are not lost on read — context an agent cannot get from the annotations alone.

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 front-loaded sentence with no filler; the core action leads and the return guarantee follows. It is dense but every clause adds information, with no repetition of the title or schema.

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 spelled out, and the description still summarizes them usefully. However, with two required identifiers and a max_bytes cap undocumented anywhere, an agent must guess at session/engagement semantics before it can call the tool correctly.

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 four parameters, and the description only gestures at 'bounded timeout' without tying it to the timeout parameter or explaining units and default. engagement_id, session_id, and max_bytes receive no meaning at all, so the description does not compensate for the coverage gap.

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 states a specific verb and resource: read pending bytes from a live serial session, plus what comes back (text, hexadecimal, buffer depth). 'Serial session' is distinctive enough to separate it from siblings like oc_workspace_read, though no sibling is named explicitly.

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?

Usage is implied rather than stated: 'live serial session' signals a session must already be open, and 'pending bytes' implies a non-blocking drain. There is no explicit when-to-use versus oc_serial_write/oc_serial_close guidance and no statement about what happens when no bytes are pending.

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

Deploy Server

Other Tools