@andysama/marlin-mcp-server

v1.1.2

Published

13 days ago

MCP server for Marlin hardware testing library

0High
0Medium
0Low

andysamawork

mcp marlin hardware verilog verilator

Marlin MCP Server

一个用于 Marlin 硬件测试库的 MCP (Model Context Protocol) 服务器，让 AI 助手能够直接与 Marlin 项目交互。

功能

工具 (Tools)

| 工具名 | 描述 | |--------|------| | marlin_build | 构建 Marlin 项目 | | marlin_test | 运行测试（支持指定包和测试名） | | marlin_check | 检查代码（不生成二进制） | | marlin_list_modules | 列出 Verilog/SystemVerilog 模块文件 | | marlin_parse_verilog | 解析 Verilog 文件，提取模块信息 | | marlin_generate_test | 生成 Rust 测试代码模板 | | marlin_check_verilator | 检查 Verilator 安装状态 | | marlin_clean | 清理构建产物 |

资源 (Resources)

marlin://workspace/cargo-toml - Cargo.toml 配置文件
marlin://workspace/readme - README 文档

安装

方式一：npx 直接运行（推荐）

npx @andysama/marlin-mcp-server

方式二：全局安装

npm install -g @andysama/marlin-mcp-server
marlin-mcp-server

方式三：从源码构建

git clone https://github.com/andysama/marlin-mcp-server.git
cd marlin-mcp-server
npm install
npm run build

配置

Windsurf

编辑 ~/.codeium/windsurf/mcp_config.json：

{
  "mcpServers": {
    "marlin": {
      "command": "npx",
      "args": ["-y", "@andysama/marlin-mcp-server"],
      "env": {
        "MARLIN_ROOT": "E:/vue/PiLoT/A-box/marlin",
        "VERILATOR_ROOT": "E:/java-environment/msys64/mingw64/share/verilator"
      }
    }
  }
}

Claude Desktop

编辑 %APPDATA%/Claude/claude_desktop_config.json：

{
  "mcpServers": {
    "marlin": {
      "command": "npx",
      "args": ["-y", "@andysama/marlin-mcp-server"],
      "env": {
        "MARLIN_ROOT": "/path/to/marlin",
        "VERILATOR_ROOT": "/usr/share/verilator"
      }
    }
  }
}

环境变量

| 变量名 | 说明 | 默认值 | |--------|------|--------| | MARLIN_ROOT | Marlin 项目根目录 | 当前工作目录 | | VERILATOR_ROOT | Verilator 安装目录 | 系统默认 |

使用示例

配置完成后，可以在 AI 助手中使用以下命令：

构建项目

帮我构建 Marlin 项目

运行测试

运行 example-verilog-project 的测试

检查 Verilator

检查 Verilator 是否正确安装

解析 Verilog 模块

解析 examples/verilog-project/src/main.sv 文件

生成测试模板

为 Counter 模块生成测试代码，包含 clk、rst 输入和 count 输出

开发

# 安装依赖
npm install

# 开发模式运行
npm run dev

# 构建
npm run build

# 运行
npm start

License

MIT