Waveform MCP

🚀 Waveform MCP 服務器

Waveform MCP 服務器是一個使用 WAL（波形分析語言）進行 RTL 波形分析的 MCP（模型上下文協議）服務器，能夠幫助用戶高效地對 RTL 波形進行各種分析操作。

🚀 快速開始

要使用 Waveform MCP 服務器，你可以按照以下步驟進行操作：

1. 安裝服務器（具體安裝步驟見下方“📦 安裝指南”）。
2. 配置 MCP 客戶端（具體配置方法見下方“💻 使用示例”）。
3. 利用提供的工具進行波形分析。

✨ 主要特性

• 豐富的工具集：提供了多種工具，如獲取信號列表、提取信號轉換、獲取波形長度、執行 WAL 表達式等，滿足不同的波形分析需求。
• 多格式支持：支持 VCD（值變更轉儲）、FST（快速信號跟蹤）等多種波形文件格式，以及 WAL 支持的其他格式。
• 與 WAL 集成：基於 WAL（波形分析語言）構建，可藉助 WAL 的強大功能進行高級波形分析。

📦 安裝指南

常規安裝

pip install -e .

開發環境安裝

若要搭建開發環境，需安裝 dev 依賴項：

pip install -e .[dev]

💻 使用示例

基礎用法

配置 MCP 客戶端

將以下內容添加到你的 MCP 客戶端配置中：

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

高級用法

使用各種工具進行波形分析

以下是各個工具的使用示例：

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"}}

📚 詳細文檔

支持的格式

• VCD（值變更轉儲）
• FST（快速信號跟蹤）
• 其他 WAL 支持的格式

依賴要求

開發與測試

• 開發環境：若要搭建開發環境，需安裝 dev 依賴項：

pip install -e .[dev]

• 測試：若要運行測試套件，可使用以下命令：

pytest

參考資料

• 對於 WAL 表達式語法和高級示例，請參閱 WAL 文檔。
• 本項目基於 WAL（波形分析語言） 構建，這是一種用於硬件波形分析的領域特定語言。更多信息請訪問 WAL 官網。

📄 許可證

本項目採用 BSD 3 - 條款許可證。詳情請參閱 LICENSE。