Waveform MCP

🚀 Waveform MCP Server

The MCP (Model Context Protocol) server for RTL waveform analysis using WAL (Waveform Analysis Language).

🚀 Quick Start

The Waveform MCP Server is designed for RTL waveform analysis using WAL. It provides a set of tools to interact with waveform files, extract information, and execute advanced analysis.

✨ Features

Tools

• get_signal_list: Retrieve a hierarchical list of signals from a waveform file, with optional regex filtering.
• get_signal_transitions: Extract signal transitions within specified time ranges.
• get_waveform_length: Obtain the total simulation length/duration.
• execute_wal_expression: Execute WAL expressions for advanced waveform analysis.
• get_wal_help: Access comprehensive WAL documentation and syntax reference.
• get_wal_examples: Generate signal - specific WAL examples for your waveform.

Supported Formats

• VCD (Value Change Dump)
• FST (Fast Signal Trace)
• Other formats supported by WAL

📦 Installation

pip install -e .

💻 Usage Examples

Basic Usage

To use the server, you need to add it to your MCP client configuration:

{
  "mcpServers": {
    "waveform": {
      "type": "stdio",
      "command": "waveform-mcp",
      "args": []
    }
  }
}

Advanced Usage

For WAL expression syntax and advanced examples, see the WAL documentation.

Tool Examples

get_signal_list

{"tool": "get_signal_list", "arguments": {"waveform_file": "sim.vcd", "pattern": "cpu.*"}}

get_signal_transitions

{"tool": "get_signal_transitions", "arguments": {"waveform_file": "sim.vcd", "signal_name": "clk", "start_time": 0, "end_time": 100}}

get_waveform_length

{"tool": "get_waveform_length", "arguments": {"waveform_file": "sim.vcd"}}

execute_wal_expression

{"tool": "execute_wal_expression", "arguments": {"waveform_file": "sim.vcd", "expression": "(find (= clk 1))"}}

get_wal_help

{"tool": "get_wal_help", "arguments": {"topic": "examples"}}

get_wal_examples

{"tool": "get_wal_examples", "arguments": {"waveform_file": "sim.vcd"}}

🔧 Technical Details

Development

To set up a development environment, install the dev dependencies:

pip install -e .[dev]

Testing

To run the test suite:

pytest

📚 Documentation

Requirements

• Python 3.10+
• cmake (for FST support)
• WAL (Waveform Analysis Language) >= 0.8.0
• MCP Python SDK >= 1.0.0

Credits

Built on WAL (Waveform Analysis Language), a domain - specific language for hardware waveform analysis. See the WAL website for more information.

📄 License

BSD 3 - Clause License. See LICENSE for details.