Waveform MCP

🚀 Waveform MCP Server

WAL (Waveform Analysis Language) を使用した RTL 波形解析用の MCP (Model Context Protocol) サーバーです。

🚀 クイックスタート

このサーバーは、波形解析に必要な様々なツールを提供します。以下に詳細を示します。

✨ 主な機能

get_signal_list

波形ファイルから信号の階層リストを取得し、必要に応じて正規表現でフィルタリングできます。

• waveform_file (必須): 波形ファイルのパス
• pattern (オプション): 信号をフィルタリングする正規表現パターン

例:

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

get_signal_transitions

指定された時間範囲内の信号遷移を抽出します。

• waveform_file (必須): 波形ファイルのパス
• signal_name (必須): 信号の完全な名前
• start_time (オプション): 開始時間、デフォルトは 0
• end_time (オプション): 終了時間、デフォルトはシミュレーションの終了時間

例:

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

get_waveform_length

シミュレーションの総長を取得します。

• waveform_file (必須): 波形ファイルのパス

例:

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

execute_wal_expression

高度な波形解析のために WAL 式を実行します。

• waveform_file (必須): 波形ファイルのパス
• expression (必須): 実行する WAL 式

例:

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

get_wal_help

包括的な WAL ドキュメントと構文リファレンスを取得します。

• topic (オプション): ヘルプトピック ('overview', 'functions', 'examples', 'debugging', 'syntax')

例:

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

get_wal_examples

波形に特化した信号の WAL 例を生成します。

• waveform_file (必須): 波形ファイルのパス

例:

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

📦 インストール

pip install -e .

📚 ドキュメント

サポートされるフォーマット

• VCD (Value Change Dump)
• FST (Fast Signal Trace)
• WAL がサポートするその他のフォーマット

開発環境のセットアップ

開発環境をセットアップするには、dev 依存関係をインストールします。

pip install -e .[dev]

テストの実行

テストスイートを実行するには、以下のコマンドを実行します。

pytest

使用方法

MCP クライアントの設定に追加します。

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

WAL 式の構文と高度な例については、WAL ドキュメント を参照してください。

必要条件

• Python 3.10 以上
• cmake (FST サポート用)
• WAL (Waveform Analysis Language) >= 0.8.0
• MCP Python SDK >= 1.0.0

📄 ライセンス

BSD 3条項ライセンスです。詳細は LICENSE を参照してください。