Skip to main content
Glama

waveform

Reads a compact screen summary from a stopped scope, optionally with sample arrays, without stopping or restarting acquisition.

Instructions

Read a compact screen-waveform summary from a STOPPED scope.

Set include_samples=true only when the individual time/amplitude arrays are needed. Changes waveform transfer source/format/range; does not stop or restart acquisition. Leaves transfer settings at BYTE/NORMAL. Not a full-memory capture.

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": {
      "channel": "<channel>"
    },
    "name": "waveform"
  }
}

Input Schema

NameRequiredDescriptionDefault
channelYes
include_samplesNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.0

TDQS

A3.9/5.0
Behavior4/5

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

With readOnlyHint=false and destructiveHint=false supplied, the description still earns credit by explaining why it is not purely read-only: it mutates transfer source/format/range and leaves settings at BYTE/NORMAL. It also clarifies that acquisition is not stopped or restarted. It does not say what happens if the scope is not stopped (error vs. silent failure), which is the main residual gap.

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 core action and its precondition, then parameter guidance, then side effects. Four short sentences with no filler, though the fragment 'Leaves transfer settings at BYTE/NORMAL' is terse enough to be cryptic without domain familiarity.

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?

An output schema exists, so return-value explanation is rightly omitted, and the description covers the precondition, the optional-samples decision, and side effects. Remaining gaps are minor: channel semantics and failure behavior when the scope is running.

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

Parameters3/5

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

Schema description coverage is 0%, so the description must carry parameter meaning. It handles include_samples well ('only when the individual time/amplitude arrays are needed'), but says nothing about 'channel' beyond the enum 1/2 in the schema — no indication of what a channel selects or whether both can be read.

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 first sentence names a specific verb and resource ('Read a compact screen-waveform summary') and adds a critical precondition ('from a STOPPED scope'). Clauses like 'Not a full-memory capture' and 'Changes waveform transfer source/format/range' separate it from other acquisition/read siblings, though no sibling is named directly.

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?

It gives explicit gating conditions: the scope must be stopped, and include_samples=true should be used 'only when the individual time/amplitude arrays are needed'. It also states a negative boundary ('does not stop or restart acquisition', 'Not a full-memory capture'). What's missing is any explicit routing to an alternative tool (e.g. inspect_signal or measure) for the full-memory or running-scope cases.

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