Skip to main content
Glama
Sign In
OpenBaud

OpenBaud

by Leonezz
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

run_command

Destructive

Execute a named device command over serial/USB, build the frame, await and classify the response against expected behavior, with audited outcomes and optional session or replay support.

Instructions

Execute a named command from devices//commands/ with typed params: builds the frame, awaits the response and classifies the outcome (normal | exception | silence | timeout | checksum_error | malformed) against the command's declared expect (audited; an unmet expectation is an error carrying the full result JSON). Give session_id for an open session, or port to open an ephemeral one with the device's profile transport — port may be omitted when the profile declares a selector, and accepts replay:. Commands with risk=danger additionally require acknowledge_risk=true.

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": {
      "device": "<device>",
      "command": "<command>"
    },
    "name": "run_command"
  }
}

Input Schema

NameRequiredDescriptionDefault
portNoOptional when session_id is given or the device profile has a selector
deviceYes
paramsNo
commandYes
session_idNo
acknowledge_riskNo
max_inline_bytesNoResult JSONs longer than this many bytes are written in full to .openbaud/out/ and returned as a summary carrying a full_result path — keeps huge payloads out of your context. Raise it to force large results inline.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A4.5/5.0
Behavior5/5

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

Annotations only declare non-readOnly/destructive/openWorld; the description goes well beyond by enumerating the outcome taxonomy (normal | exception | silence | timeout | checksum_error | malformed), explaining `expect` auditing and that unmet expectations return an error with full result JSON, and disclosing the risk gate (acknowledge_risk=true for risk=danger). That is substantive behavioral context an agent cannot get from the annotations.

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?

Front-loaded with the action, and every clause carries information about outcomes, session model, or risk gating. The middle sentence packs session_id, port, selector omission, and replay syntax into one long clause chain, which is dense though not wasteful.

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?

For a destructive, open-world tool with 7 params, a nested object, no output schema, and low schema coverage, the description supplies the outcome model, audit/error semantics, session-vs-ephemeral choice, and the risk acknowledgement gate. It stops short of describing how per-command `params` are shaped or how results are summarized by max_inline_bytes beyond the schema's own note.

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 only 29%, so the description has to compensate, and it largely does: session_id vs port semantics, the selector-based port omission rule, the replay:<capture path> syntax, and the acknowledge_risk requirement are all description-only. The nested `params` object and `device`/`command` remain only lightly characterized ('typed params'), leaving one meaningful gap.

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 ('Execute a named command from devices/<device>/commands/') and immediately explains the mechanism (builds the frame, awaits response, classifies outcome). This is clearly distinct from lower-level siblings like send/request or the orchestration tool run_workflow, even though no sibling is named.

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 real usage context: use session_id for an existing session, or port for an ephemeral transport, with port optionally omitted when the profile declares a selector, and replay:<capture path> accepted. It does not, however, tell the agent when to prefer this over alternatives such as run_workflow or send, so there is no explicit when-not/alternative guidance.

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