MCP Sigrok README

The full upstream README, mirrored for reference. Install config, tool schemas, adoption signals and our own overview live on the MCP Sigrok listing page.

mcp-sigrok — MCP server for sigrok-cli

PyPI Python

MCP server that exposes all functionality of sigrok-cli as MCP tools. sigrok-cli is a cross-platform command-line utility for the sigrok software suite, used for hardware initialization, acquisition, protocol decoding, and saving logic analyzer sessions.

Install

Terminal
pip install mcp-sigrok

Requirements

  • sigrok-cli must be installed on the system

Installing sigrok-cli

Debian/Ubuntu:

bash
sudo apt install sigrok-cli

macOS:

bash
brew install sigrok-cli

From source:

bash
git clone git://sigrok.org/sigrok-cli
cd sigrok-cli
./autogen.sh
./configure
make
sudo make install

Usage

As MCP Server

bash
# Run as stdio MCP server
mcp-sigrok

Or configure in your MCP settings:

config.json
{
  "mcpServers": {
    "sigrok": {
      "command": "mcp-sigrok"
    }
  }
}

Python API

server.ts
from mcp_sigrok import (
    check_sigrok_cli,
    get_version,
    list_drivers,
    scan_devices,
    capture_samples,
    load_input_file,
)

# Check if sigrok-cli is available
if cli_path := check_sigrok_cli():
    print(f"Found sigrok-cli at: {cli_path}")

# Get version info
info = get_version()

# List available drivers
drivers = list_drivers()

# Scan for devices
devices = scan_devices()

# Capture samples
result = capture_samples("fx2lafw", samples=1000)

MCP Tools

ToolDescription
versionGet sigrok-cli version info
list_supportedList all supported features
list_hardware_driversList available hardware drivers
list_input_file_formatsList supported input formats
list_output_file_formatsList supported output formats
list_protocol_decodersList available protocol decoders
scan_for_devicesScan for detectable devices
show_device_infoShow device info for a driver
captureCapture samples from hardware
capture_for_timeCapture data for duration
load_fileLoad and process input file
show_decoder_docsShow protocol decoder docs
set_configSet driver configuration

Examples

Capture from logic analyzer

python
# Capture 1000 samples from fx2lafw device
result = capture(
    driver="fx2lafw",
    samples=1000,
    channels="0-7",
    output_format="hex"
)

Decode I2C protocol

python
# Load capture file and decode I2C
result = load_file(
    input_file="capture.sr",
    protocol_decoders="i2c",
    output_file="decoded.txt"
)

Scan for devices

python
# Find available devices
devices = scan_for_devices()
for device in devices.get("devices", []):
    print(f"Found: {device}")

Development

bash
git clone https://github.com/daedalus/mcp-sigrok.git
cd mcp-sigrok
pip install -e ".[test]"

# run tests
pytest

# format
ruff format src/ tests/

# lint
ruff check src/ tests/

# type check
mypy src/

mcp-name: io.github.daedalus/mcp-sigrok