siglent-sds-mcp

Overview Schema Source Related Servers Discussions Admin

generate_report

Compile captured oscilloscope screenshots, waveforms, and protocol analysis JSON into a structured Markdown field report for documentation and debugging.

Instructions

Generate a Markdown field report from captured artifacts and JSON summaries.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "generate_report"
  }
}

Input Schema

Name	Required	Default
`notes`	No
`title`	No	SIGLENT SDS field capture report
`scenario`	No
`scope_idn`	No
`output_path`	No	artifacts/reports/report.md
`screenshot_path`	No
`waveform_csv_paths`	No
`modbus_timing_json_path`	No
`uart_analysis_json_path`	No
`waveform_metadata_paths`	No
`rs485_analysis_json_path`	No

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Aug 6, 2026

TDQS

B3.2/5.0

Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure, but it only says 'generate a Markdown field report.' It fails to mention that the tool writes to a file (via output_path), reads multiple external files, or any side effects or prerequisites. This is a significant transparency gap for a tool with many inputs.

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?

The description is a single concise sentence that is front-loaded with the core purpose. It earns its place, but given the tool's complexity (11 parameters), the extreme brevity borders on under-specification rather than clean conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has high complexity (11 parameters, no annotations, no explicit output schema details visible) and the description is a one-liner. It does not explain the workflow, what artifacts are expected, how the report is structured, or what happens if required inputs are missing. The description is far from complete for an agent to invoke this 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%, and the description gives only a generic phrase 'captured artifacts and JSON summaries' which vaguely maps to parameters like screenshot_path, waveform_csv_paths, and *_json_paths. It provides no specific meaning for any of the 11 parameters, leaving the agent to infer their roles.

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?

The description states a clear action ('Generate') and a specific resource ('Markdown field report') with source materials ('captured artifacts and JSON summaries'). This clearly distinguishes it from sibling tools, none of which generate reports; it is the only reporting tool in the list.

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?

There is no explicit 'when to use' or alternatives, but the phrase 'from captured artifacts and JSON summaries' implies it should be used after capture/analysis tools have produced these artifacts. This is only implied, not stated, such as 'after using capture_* and analyze_* tools'.

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