Skip to main content
Glama

vivado-mcp

PyPI version Python License CI

让 Claude Code、Cursor、Codex 等 AI Agent 安全驱动本地 Xilinx Vivado。

32 个 MCP 工具覆盖会话、综合、实现、时序、CDC、XDC、IP、波形与烧录。可保存结构化时序结果、比较两次测量、离线查询 VCD 中的未知值与握手事件;通用 Vivado 操作由 run_tcl 承载。

32 个精选工具

11 个工作流 Prompt + 5 个 Skills

2 个实时 Resources

GUI / Tcl / attach 三种会话

本项目控制的是你本机安装的 Vivado,不是云端综合服务。命令在当前用户权限下执行;工具说明和诊断建议以中文为主。

English: A local Vivado MCP server with 32 tools, structured timing evidence and baseline comparison, bounded offline VCD queries, 11 workflow prompts, and 5 reusable skills.

导航:快速开始 · 实际调试场景 · 工具设计 · 工作流 Prompts · 工具列表 · 调试指南与 Skills · CLI · 反馈

环境要求

  • Python ≥ 3.10,Windows / Linux

  • Xilinx Vivado:必须安装在运行 vivado-mcp 的本机

  • MCP Python SDK 2.x:唯一直接运行时依赖,pip 会自动安装

Vivado 版本

支持等级

验证范围

2019.1

主要支持基线

作者长期实测 GUI / Tcl / attach 与完整 FPGA 流程

2018.3

部分路径验证

社区贡献者验证 IPDEF-only IP 元数据(PR #1)

2022.2

社区现场验证

Windows 10 GUI/XSim 问题现场(Issue #2),不代表完整回归

其他版本

实验性兼容

协议层为纯 Tcl,但未持续做真机矩阵;请先跑下方冒烟验证

Related MCP server: vivado-mcp-agent

快速开始

1. 安装

python -m pip install vivado-mcp

多 Python 环境下,请让 MCP 客户端使用同一个 Python 解释器;必要时把下方配置中的 python 换成该解释器的绝对路径。

2. 先运行环境诊断

vivado-mcp doctor

doctor 默认完全只读,检查 Vivado 路径、init Tcl 注入、9999 端口协议、Claude Code/Codex 配置,并给出精确的修复计划。CI 或 Agent 可使用结构化输出:

vivado-mcp doctor --json

3. 注入 Vivado(一次性)

vivado-mcp install

这会修改你 Vivado 的 Vivado_init.tcl,让以后启动 GUI 时自动开启 TCP server(绑定 install 指定的单一端口,默认 9999;被占即退出,不会滑动到其他端口)。原文件会备份,vivado-mcp uninstall 可恢复。

如果 Vivado 装在受保护目录(如 C:\Program Files\),用管理员身份运行命令即可。

也可以让 doctor 执行安全修复:

vivado-mcp doctor --fix --client all

--fix 才会写文件:复用幂等的 Vivado 注入,并在备份后原子更新选定客户端配置;不会删除第三方注入、终止占用端口的进程或自动升级软件。

4. 配置 MCP 客户端

doctor --fix 可自动配置 Claude Code 和 Codex。手动配置时,Claude Code 使用 ~/.claude.json,Cursor 使用项目级 .cursor/mcp.json 或用户级 ~/.cursor/mcp.json;两者都在 mcpServers 中加入:

"vivado": {
  "command": "python",
  "args": ["-m", "vivado_mcp"],
  "env": {
    "VIVADO_PATH": "D:/Xilinx/Vivado/2019.1/bin/vivado.bat"
  },
  "type": "stdio"
}

Codex 使用 ~/.codex/config.toml:

[mcp_servers.vivado]
command = "python"
args = ["-m", "vivado_mcp"]

[mcp_servers.vivado.env]
VIVADO_PATH = "D:/Xilinx/Vivado/2019.1/bin/vivado.bat"

将 VIVADO_PATH 替换为你的 Vivado 实际路径:

  • Windows: "D:/Xilinx/Vivado/2019.1/bin/vivado.bat"

  • Linux: "/opt/Xilinx/Vivado/<版本>/bin/vivado"

  • 也可以不设置 VIVADO_PATH,将 Vivado bin 目录加入系统 PATH。

VIVADO_PATH 负责让 MCP server 找到 Vivado 可执行文件;上一步的 vivado-mcp install 负责给 GUI/attach 模式注入 TCP server。其他支持 stdio MCP 的客户端使用相同的 command、args 和 env,配置文件位置以客户端文档为准。

5. 重启 MCP 客户端

配置完成后重启客户端,即可加载 32 个工具、11 个工作流 Prompt 和 2 个会话状态 Resource。五个 Skills 已随 Python 包分发,可显式导出到自选目录;不会自动修改客户端配置。对应 Prompt 从同一正文读取。

6. 冒烟验证

在客户端中发送:

启动一个 GUI 会话,然后执行 Tcl: version -short

AI 应依次调用 start_session(mode="gui") 和 run_tcl("version -short")。成功时 Vivado GUI 会启动(已有注入服务则直接 attach),并返回版本号。失败时直接运行 vivado-mcp doctor,无需逐项猜配置。

若 MCP 启动 GUI 时出现“进程提前退出”或连接超时,先查看错误中列出的 Vivado 启动日志和 Launcher 日志。启动器的错误可能发生在 Vivado 日志创建之前,因此两份都需要检查。日志默认位于系统临时目录的 vivado-mcp/logs,可用 VIVADO_MCP_LOG_DIR 指定目录;成功后也可从 list_sessions 的 startup_log / launcher_log 字段找到路径。 这些文件会继续记录该 GUI 进程的输出,关闭会话后保留,便于后续诊断。

如果手动打开同一 Vivado 能正常工作,可先完成上述 install 注入,再手动启动 GUI,使用 start_session(mode="attach", port=9999) 连接;安装时使用自定义 端口的,填写该端口。attach 不会新建 GUI 或本次启动日志。提交问题时请附上 版本、手动启动对照结果和相关错误片段,单独一个退出码不足以确定原因。

git clone https://github.com/mapleleavessssssss-wq/vivado-mcp.git
cd vivado-mcp
pip install -e ".[dev]"

各版本的完整变更和迁移说明见 CHANGELOG。

实际调试场景

你想解决的问题

使用方式

得到什么

修改 RTL 后,时序到底变了多少?

get_timing_report(output_format="json"),保存结果后在下一轮传 baseline_file

setup / hold / pulse-width 指标、设计阶段、同阶段可比指标的差值;不会把综合估算当成最终验收

同事只发来一份时序报告

get_timing_report(report_file="reports/timing.rpt", output_format="json")

无需 Vivado 会话即可分析;报告的来源、缺失字段与未验证项明确列出

仿真某处出现 X/Z,或握手是否发生?

query_waveform(file_path="sim/trace.vcd", ...)

信号层次、时间窗内变化、未知值与条件匹配;输出数量有上限

拿到 CDC 报告,想定位跨域风险

get_cdc_report(report_file="reports/cdc.rpt")

时钟对、规则和严重级别、明细、豁免与缺失证据;不凭零告警宣称签核

接手陌生工程,不知道从哪开始

工程接管 Skill

环境与工程摸底、首个阻塞问题、后续工具调用路线

完整参数、可复制例子和 Skills 使用方法见 调试指南。波形查询当前支持 VCD;WDB/FST 请先使用相应工具导出 VCD。

工具设计

部分同类 Vivado MCP 采用数百个细粒度工具,其中许多只是单条 Tcl 的包装。问题是:

  • 过多相似入口增加工具选择和维护成本;具体上下文开销取决于客户端如何发现、加载工具。

  • 单条 Tcl 操作可直接由 run_tcl 或 safe_tcl 完成。

  • 结构化分析、可靠的多步操作和离线数据处理值得提供专门入口。

本项目只保留真正有本地价值的工具——Tcl 做不了或做不好的事:

  1. 结构化解析:IO / 时序报告 → JSON / 中文摘要(比原始表格省 token)

  2. 本地知识库:CRITICAL WARNING 按 ID 分类 + 中文修复建议(Tcl 里写这个太难)

  3. 跨命令协议:sentinel、会话管理、超时、比特流前置安全检查

  4. 跨会话工具:compare_xci 纯 Python 对比两个 XCI 文件,不需要 Vivado

其他(BD / 仿真 / XSCT / 硬件调试 / IP 配置等)全部交给 run_tcl,让大模型自己拼 Tcl。

特性

  • 三种会话模式:GUI 可视化、Tcl 无头运行,以及只连接现有 GUI 的 attach

  • 32 个精选工具 — 覆盖 FPGA 开发流程、智能诊断、离线解析和外部工具链联动

  • 11 个证据驱动工作流 — 每个流程都要求新鲜基线、最小安全修改、复测门禁与明确停止条件

  • 一条命令自检 — doctor 只读定位环境问题,doctor --fix 才执行受限、可备份的修复

  • 可靠的长任务协议 — 综合/实现支持 wait=False 立即返回 job id,再由 get_run_progress 查询

  • 超时响应不串台 — 每个 session 保留在途响应所有权;旧响应完成前拒绝下一命令,不会把 FIRST 的结果交给 SECOND

  • 智能诊断 — 综合/实现后自动提取 CRITICAL WARNING / ERROR 分类 + 中文修复建议(含 18+ 种已知 ID)

  • IO 验证 — XDC 约束(支持 -dict 和传统两种语法)对比实际引脚分配,GT 端口不匹配标记为 CRITICAL

  • IP 调试 — 查询 IP 所有 CONFIG.* 参数(含 GUI 隐藏参数)、纯 Python 对比两个 XCI 文件

  • Bitstream 安全检查 — 生成比特流前自动检测 CRITICAL WARNING 并阻止(可 force 跳过)

  • 结构化报告 — IO 和时序报告解析为 JSON,便于 AI 精确提取数值(不再有"假 PASS"陷阱)

  • 安全转义 — safe_tcl 自动对路径/标识符做 Tcl list 转义,Windows 含空格/中文/$ 的路径也能用

  • 多会话支持 — 默认复用端口 9999 的单个 GUI(不同 session_id 也 attach 同一台);传 port=0 自动分配空闲端口启动独立实例;server 只绑单一端口,被占即退出不滑动

工作流 Prompts

Prompts 解决的是“按什么顺序做、什么证据才算完成”,不会增加工具数量。正文只在选择该 Prompt 时加载,不会全部常驻上下文。

五个可分发 Skill 与对应 Prompt 使用同一份正文。查看及导出:

vivado-mcp skills list
vivado-mcp skills export ./fpga-skills
vivado-mcp skills export ./fpga-skills --skill vivado-cdc-audit

将导出的目录按客户端支持的方式导入即可。导出不覆盖已有修改:内容相同则跳过,冲突则报错,可选新目录重新导出。无需安装 SynthPilot 或 oh-my-fpga。

Prompt

用途

核心门禁

fpga_workflow

RTL 到 bitstream 的完整流程

上游失败不进入下游,post-route signoff 后才写 bitstream

debug_timing

setup/hold 时序收敛

baseline → 分类 → 最小修复 → 同指标复测,禁止假 false path

debug_gt_mapping

GT 引脚与 Lane 映射

原理图/XDC/实际布局三方证据一致后再改约束

debug_ip_config

IP 参数与 XCI 漂移

golden 来源可信、修改后 regenerate + synthesis 验证

debug_pcie

PCIe 分层排查

物理 → 时钟复位 → 时序 → 协议,上一层未过不下钻

simulation_bringup

XSim 编译、运行与失败分类

compile 不等于 pass;必须有非零测试和新鲜运行结果

cdc_audit

CDC crossing 审计

不用 waiver 隐藏真实 crossing,约束必须有结构证据

ila_hardware_debug

ILA 插入、烧录与采波

bit/ltx 配对、明确 JTAG target、有限等待,禁止全机 kill XSim

project_bringup

接管或建立工程,按请求范围推进

静态预检、功能验证和构建逐阶段记录

waveform_debug

已有 VCD 离线查询与必要时导出

明确信号、窗口、截断与独立测试结论

constraints_authoring

编写或审查 XDC

参数来自接口/板级事实,验证对象、min/max 与例外覆盖

会话模式

start_session 工具支持三种模式:

mode

效果

适合

"gui" (默认)

先 probe 端口(0.3.19+):已有 vmcp server 直接 attach,没有才 spawn vivado -mode gui

交互开发、实时观察波形/原理图;支持复用你手动开的 GUI(只要装过 vivado-mcp install)

"tcl"

vivado -mode tcl 无头子进程

CI、批处理、不需要 GUI

"attach"

只 attach,不 spawn(端口无 server 时直接报错)

严格保证不会启新 GUI 进程的场景

用户: 启动 GUI 会话
AI: [调用 start_session(mode="gui")]
    → 端口空 → spawn 新 Vivado;端口已有 → attach 到现有 GUI(0.3.19+)
    
用户: 我刚自己手动开了 Vivado GUI,直接接管
AI: [调用 list_sessions]   → 看到 <external@9999>(你手动开的)
    [调用 start_session(mode="gui")]   → 自动 attach,不会再开第二个 GUI

用户: 批处理跑 10 个项目
AI: [调用 start_session(mode="tcl")] → 无 GUI,跑得更快

长时间综合/实现可以启动后立即返回,不占住一次 MCP 调用:

run_synthesis(run_name="synth_1", session_id="default", wait=False)
→ 综合已异步启动。job_id: default:synth_1

get_run_progress(run_name="synth_1", session_id="default")
→ STATUS / PROGRESS / 当前 phase / log tail / 最后更新时间

job_id 是由 session_id:run_name 组成的任务回执;查询时将两部分分别传给 get_run_progress。默认 wait=True 保持原有“等待完成并自动诊断”的兼容行为。每个 session 的命令严格串行,不同 session 可并行。

Resources

  • vivado://sessions:当前所有会话的结构化状态

  • vivado://session/{session_id}/status:指定会话的状态、模式、端口与存活信息

工具列表

会话管理

工具

说明

start_session

启动 Vivado 会话(gui/tcl/attach 三种模式)

stop_session

关闭指定会话(B13 修复:taskkill /T 递归杀进程树 + 清 vivado_pid*.str)

list_sessions

列出所有活跃会话

Tcl 执行(核心)

工具

说明

run_tcl

执行任意 Vivado Tcl 命令——AI 拼命令的主力

safe_tcl

带参数模板,自动 Tcl 转义,路径含空格/中文/$ 时使用

设计流程

工具

说明

run_synthesis

运行综合,Python 轮询不阻塞,完成后自动 open_run + 诊断

run_implementation

运行实现(布局布线)

get_run_progress

0.3.2 查 run 实时进度:Phase 序列 + log 尾部 + mtime,log 超 2 分钟不更新自动提示可能卡住

generate_bitstream

生成比特流(默认前置 CRITICAL WARNING 安全检查)

program_device

编程 FPGA 设备(封装 open_hw_manager → connect → program)

新手引导 & 工程摸底

工具

说明

get_next_suggestion

0.3.2 11 档决策表:没项目 → open/create,没顶层 → set_property TOP,综合完成 → run_implementation...每档附可执行命令

get_project_info

0.3.0 一次拿齐项目摸底:名称/part/顶层/源文件/XDC/IP/runs 状态

get_pre_commit_summary

0.3.4 生成 markdown 工程摘要直接贴 commit body:项目/时序 WNS+WHS/资源/CW/READY-WARN-BLOCK 门禁

诊断(独家差异化)

工具

说明

get_critical_warnings

提取并按 ID 分类 CRITICAL WARNING + ERROR,含 18+ 种已知 ID 的中文修复建议。0.3.9 加 compare_with_last=True 差分。0.3.14 errors=0+cw=0 但 STATUS=ERROR 时 tail runme.log 扫非标关键词(TclStackFree/segfault/中文路径 cmd 报错)。0.3.15/16 run_name='sim_*' 时:先 glob xsim/*.log;全空就自动 launch_simulation -scripts_only + Vivado session 内 exec 跑 compile/elaborate.bat 抓真错

check_bitstream_readiness

0.3.0 烧板前一键 READY/WARN/BLOCK 综合判定

verify_io_placement_tool

对比 XDC 约束(-dict/传统两种语法)与实际 IO 布局,GT 不匹配标为 CRITICAL

xdc_lint

0.3.0 纯 Python 静态 XDC 检查(PIN_CONFLICT / 漏 IOSTANDARD / DUPLICATE_PORT / CLOCK_NO_PERIOD / 跨文件冲突),不需 Vivado

xdc_auto_fix

0.3.3 自动补 IOSTANDARD + create_clock -period,dry_run 预览 + 板卡 profile(basys3/nexys-a7/arty-a7/zybo/kc705),不碰 PIN_CONFLICT

verilog_compile_check

0.3.4 用 iverilog / verilator 做语法 + 连接性检查,通常远快于完整 Vivado 综合。未装返回 SKIP + 安装指引,支持 Windows+scoop 路径自动发现

IP 调试

工具

说明

inspect_ip_params

查询 IP 实例所有 CONFIG.* 参数(含 GUI 隐藏项),支持关键词过滤

compare_xci

纯 Python 对比两个 XCI 文件的参数差异(无需 Vivado 会话)

get_ip_status

0.3.4 检查哪些 IP 需要升级 / 被锁定 / 已最新,附 upgrade_ip 批量建议

离线摸底(无需 Vivado 会话,纯 Python)

工具

说明

parse_xpr

0.3.23 离线解析 .xpr 工程文件——不启 Vivado 秒级拿 part/顶层/源文件(按 fileset 分组,含 .v/.mem/.xci IP)/XDC/runs。对照 get_project_info 需先 open_project(中文路径会 TclStackFree 崩)

parse_bit_header

0.3.23 离线解析 .bit 头部——设计名/part(原始 7k325tffg900 + 规整 xc7k325tffg900)/构建日期时间/SHA256。烧前防错板 + 交付对账,Vivado 无 Tcl 命令读离线 .bit

parse_ltx

0.3.23 离线解析 .ltx ILA 探针清单——probe 名/位宽/映射 net。连板抓波前先拿清单,get_hw_probes 需活 hw session

结构化报告

工具

说明

get_io_report

IO 引脚报告(JSON),自动判定 GT/GPIO 类型

get_timing_report

文本 / JSON 时序证据,标注设计阶段;支持 report_file 离线报告与 baseline_file 基线对比,含 setup / hold / pulse-width 指标和违例路径分析。缺数据不能判为通过

get_cdc_report

现场/离线 CDC JSON,按规则与时钟对统计报告检查条目,保留豁免和明细截断信息;不修改约束、不判完整签核

get_utilization_report

0.3.0 结构化资源占用(LUT/FF/BRAM/DSP/IOB),> 90% 标 CRITICAL,70-90% 标 WARN

通用报告(power / drc / clock / methodology 等)请直接用 run_tcl("report_power -return_string"),无需包装。

波形显示(XSim)

工具

说明

set_wave_zoom

0.3.22 设置波形时间缩放窗:改 .wcfg XML → close -force → open 重载(Vivado 2019.1 无 Tcl zoom 命令,跨命令协议封装)

set_wave_analog

0.3.22 把信号设为 Analog 模拟显示:自动补 STYLE_ 前缀 + 全路径/显示名寻址 + 空对象判空(三个实测静默坑一次封掉)。注意先 zoom 后 analog(重载会冲掉 analog 设置)

波形数据查询(无需 Vivado 会话)

工具

功能

query_waveform

读取 VCD,发现信号层次、查询指定时间窗、匹配值 / 变化 / X/Z / 多信号相等条件。返回 timescale、初值、有限事件及截断标志;不据此直接判定仿真通过

可选:Claude Code Hook 配置示例

注意:.claude/ 目录不随仓库 / PyPI 包分发,下面是一份可选的 hook 配置示例, 复制到你自己项目的 .claude/settings.json 即可启用。hook 里 import 的 vivado_mcp.analysis 模块随 pip install vivado-mcp 一起装好,无需额外脚本。 所有 hook 命令均为单行 python -c(分号串联)——Windows cmd 与 bash 下都能直接执行, 多行 python -c 在 cmd 下会 SyntaxError 静默失效,自行改写时请保持单行。

配好后 AI 不只会"被动应答",还能主动守门:

Hook

触发事件

作用

bitstream-guard

AI 调 generate_bitstream 前

弹确认框(permissionDecision: ask):提醒先跑 check_bitstream_readiness,由你决定放行或拒绝,不会硬阻断流程

xdc-lint

保存任意 .xdc 文件后

纯 Python 静态检查:PIN_CONFLICT / 漏 IOSTANDARD / create_clock 缺 -period 等,无需等综合

verilog-lint

保存任意 .v / .sv 文件后

零依赖预检:module 名匹配文件名 / endmodule 存在 / 括号配对

iverilog-check

保存任意 .v / .sv 文件后

0.3.4 iverilog 或 verilator 语法+连接性检查,未装静默跳过,有 error 时阻断

session-guard

Claude 停下时

扫 vivado_pid*.str 文件,提醒清理未关闭的 Vivado session

{
  "hooks": {
    "PreToolUse": [
      {
        "matcher": "mcp__vivado__generate_bitstream",
        "hooks": [
          {
            "type": "command",
            "statusMessage": "bitstream-guard",
            "command": "python -c \"import json; print(json.dumps({'hookSpecificOutput': {'hookEventName': 'PreToolUse', 'permissionDecision': 'ask', 'permissionDecisionReason': '烧板前确认已跑 check_bitstream_readiness 且结论为 READY(时序违例/未布线状态下生成的是无效比特流)'}}))\""
          }
        ]
      }
    ],
    "PostToolUse": [
      {
        "matcher": "Write|Edit",
        "hooks": [
          {
            "type": "command",
            "statusMessage": "xdc-lint",
            "command": "python -c \"import json,sys; sys.stderr.reconfigure(encoding='utf-8'); d=json.load(sys.stdin); fp=d.get('tool_input',{}).get('file_path') or d.get('tool_response',{}).get('filePath') or ''; fp.lower().endswith('.xdc') or sys.exit(0); from vivado_mcp.analysis.xdc_linter import lint_xdc_files, format_lint_report; r=lint_xdc_files([fp]); r.issues and (sys.stderr.write('[xdc-lint hook] '+format_lint_report(r)+chr(10)), sys.exit(2))\""
          },
          {
            "type": "command",
            "statusMessage": "verilog-lint",
            "command": "python -c \"import json,sys; sys.stderr.reconfigure(encoding='utf-8'); d=json.load(sys.stdin); fp=d.get('tool_input',{}).get('file_path') or d.get('tool_response',{}).get('filePath') or ''; fp.lower().endswith(('.v','.sv')) or sys.exit(0); from vivado_mcp.analysis.verilog_quick_check import quick_check_verilog, format_report; t=format_report(quick_check_verilog(fp)); t and (sys.stderr.write('[verilog-lint hook] '+t+chr(10)), sys.exit(2))\""
          },
          {
            "type": "command",
            "statusMessage": "iverilog-check",
            "command": "python -c \"import json,sys; sys.stderr.reconfigure(encoding='utf-8'); d=json.load(sys.stdin); fp=d.get('tool_input',{}).get('file_path') or d.get('tool_response',{}).get('filePath') or ''; fp.lower().endswith(('.v','.sv')) or sys.exit(0); from vivado_mcp.analysis.verilog_compile_check import compile_check, format_compile_report; r=compile_check([fp], tool='auto', timeout=15.0); r.tool_available or sys.exit(0); r.errors and (sys.stderr.write('[iverilog-check hook] '+format_compile_report(r)+chr(10)), sys.exit(2))\""
          }
        ]
      }
    ],
    "Stop": [
      {
        "hooks": [
          {
            "type": "command",
            "statusMessage": "session-guard",
            "command": "python -c \"import sys,glob; sys.stderr.reconfigure(encoding='utf-8'); pids=glob.glob('vivado_pid*.str'); pids and (sys.stderr.write('[session-guard] 发现未清理的 Vivado session 痕迹: '+', '.join(pids)+'。建议用 mcp__vivado__stop_session 清理,或手动删除 .str 文件。'+chr(10)), sys.exit(2))\""
          }
        ]
      }
    ]
  }
}

把片段写入你项目的 .claude/settings.json 后,Claude Code 打开该项目时会弹框:"检测到项目配置了 hook,是否信任?" — 选 Yes 即启用。

要禁用单个或全部:在 .claude/settings.local.json(个人本地文件,不进 git)写入 {"hooks": {}} 覆盖即可。

使用示例 — 一轮完整的调试闭环

下面是 Vivado 2019.1 的两组实机片段:Basys 3 工程用于演示 IO/DRC 修复,独立的 Kintex-7 PCIe XDMA 工程用于演示时序诊断。两组结果串起 get_critical_warnings → XDC 修复 → compare_with_last 验证 → 时序自动诊断 → 烧板的完整闭环。

起点:打开项目,立刻看 ERROR / CW 详情

用户: 打开 basys3_uart 工程看看为什么 impl 挂了
AI:  [start_session(mode="gui")]
     [run_tcl("open_project .../basys3_uart.xpr")]
     [get_critical_warnings(run_name="impl_1")]

     !! 发现 3 条 ERROR !!
     诊断概览: errors=3, critical_warnings=0, warnings=0

     --- [ERROR][DRC BIVC-1] IO_STANDARD_MISMATCH (1 条) ---
       首次出现: 第 165 行
       示例消息: Bank IO standard Vcc: Conflicting Vcc voltages in bank 14...
       建议: Bank 内 IOSTANDARD 不一致(同一 Bank 的端口用了不同电压,如 LVCMOS18 和 LVCMOS33)。
       修复: 在 XDC 给所有端口显式指定 IOSTANDARD,同 Bank 保持电平一致。

     --- [ERROR][Vivado_Tcl 4-23] DRC_FAILED (1 条) ---
       建议: DRC 失败导致 Placer 未运行。
       修复: 查看同一日志里前面的 [DRC xxx-N] 定位根因,常见是 BIVC-1/NSTD-1/UCIO-1。

     --- [ERROR][Common 17-39] STAGE_ABORT (1 条) ---
       建议: 前置阶段失败导致后续阶段未能启动。

诊断第一步就锁定根因:BIVC-1 在 Bank 14 有电压冲突,后两条 ERROR 都是连锁反应。

修 XDC + 再综合

用户: 按建议在 XDC 里给所有端口显式补 IOSTANDARD 再综合
AI:  [xdc_auto_fix(board="basys3", dry_run=false)]   # 0.3.3 一键补 IOSTANDARD
     [run_synthesis]
     [run_implementation]

验证真的修到了点 — compare_with_last 差分

用户: 确认一下修好了
AI:  [get_critical_warnings(run_name="impl_1", compare_with_last=True)]

     诊断概览: errors=0, critical_warnings=0, warnings=3

     === CW 差分报告(对比上次快照)===
     修复效果: 已消除 3 条 / 新出现 0 条 / 仍存在 0 条

     [-] 已消除(3):
       • [DRC BIVC-1] IO_STANDARD_MISMATCH
       • [Vivado_Tcl 4-23] DRC_FAILED
       • [Common 17-39] STAGE_ABORT

     结论: 修复生效,所有上次存在的问题均已消除。

不需要人工对比两份日志 —— 差分直接给结论:3 条 ERROR 都消了,修复生效。

时序违例?自动给 Tcl 修复命令(0.3.9 亮点)

换到一个 WNS 违例的大工程(PCIe XDMA):

用户: 时序没过,告诉我怎么改
AI:  [get_timing_report]

     === 时序摘要 === 状态: FAIL (时序违例)
       Setup  WNS = -9.247 ns  TNS = -495735.094 ns
              失败端点: 247261 / 247354
       Hold   WHS = +0.015 ns  THS = 0.000 ns

     --- 违例路径 Top 10 ---
       [1] SETUP slack -9.247 ns  [HIGH_FANOUT]
           起点: .../xdma_0/.../tready_thrtl_reg/C
           终点: .../pcie_7x_i/pcie_block_i/CFGPMTURNOFFOKN
           延迟分解: logic 0.309 ns  route 2.094 ns  skew -6.845 ns  levels=2
           建议: 布线延迟(2.094 ns)远大于逻辑延迟(0.309 ns),通常是高扇出或跨芯片走线。
                 先跑 `report_high_fanout_nets -fanout_greater_than 1000` 定位,
                 然后对主干寄存器加 `set_property MAX_FANOUT 50 [get_cells <...>]`,
                 或在综合阶段加 `-fanout_limit 50` 让工具自动复制寄存器。

       [2] SETUP slack -9.219 ns  [HIGH_FANOUT]
           ...

不再有"时序挂了,咋办"的空转 —— 工具直接按模式(CDC / HIGH_FANOUT / LONG_COMBO / IO_UNREGISTERED / UNKNOWN)分类,给出具体 Tcl 命令。

烧板前安全门 + 编程设备

用户: 修好后准备烧板
AI:  [check_bitstream_readiness]
     核对目标实现 run、当前打开设计阶段、setup/hold/pulse-width 和 CW 查询是否完整。
     只有证据完整且不存在阻塞项才继续;CW=8 时不能当成 READY。

     [generate_bitstream]          # 先解决诊断问题,默认不跳过检查
     [program_device(bitstream_path="impl_1/top.bit")]  # 用户要求烧录且已确认设备时

常用旁路工具

其他单次查询/对比用例:

# 对比两个 XCI 找出配置漂移
compare_xci(file_a="golden.xci", file_b="suspect.xci")
# → PF0_DEVICE_ID: A=9024 | B=9038
# → LINK_SPEED:    A=5.0_GT/s | B=8.0_GT/s

# 验证 GT 引脚实际布局是否和 XDC 一致(支持 -dict 语法)
verify_io_placement_tool
# → !!! CRITICAL 不匹配 !!!  端口: pcie_7x_mgt_rtl_0_rxp[0]
#    XDC: AA4 | 实际: M6

# 任意 Tcl — AI 拼命令的主力
run_tcl("foreach p [get_ports] { puts \"$p: [get_property PACKAGE_PIN $p]\" }")
safe_tcl("set_property PACKAGE_PIN {0} [get_ports {1}]", args=["W5", "clk"])

架构

flowchart LR
    Agent["Claude Code / Cursor / Codex"] -->|"stdio MCP"| MCP["vivado-mcp"]
    MCP --> Tools["32 Tools"]
    MCP --> Prompts["11 Workflow Prompts"]
    MCP --> Resources["2 Session Resources"]
    Tools --> Tcl["SubprocessSession\nmode=tcl"]
    Tools --> Gui["GuiSession\nmode=gui"]
    Tools --> Attach["GuiSession\nmode=attach"]
    Tcl -->|"stdio + UUID sentinel"| VivadoTcl["vivado -mode tcl"]
    Gui -->|"TCP length-prefix"| VivadoGui["local Vivado GUI"]
    Attach -->|"TCP length-prefix"| VivadoGui

核心协议:

  • subprocess 模式:catch + UUID sentinel(stdio 分帧,修复了 0.1.0 的行顺序 bug)

  • GUI/attach 模式:TCP length-prefix framing(4 字节 BE + UTF-8 payload)

  • 命令通过十六进制编码传输,避免 Tcl 注入,并覆盖含空格、中文和特殊字符的路径

  • 每个 session 同时只拥有一个在途响应;调用超时不会释放协议所有权,避免迟到响应污染下一条命令

CLI 参考

命令

说明

python -m vivado_mcp

启动 MCP server(供 AI 工具调用)

vivado-mcp serve

同上

vivado-mcp install [path] [--port 9999]

注入 Vivado_init.tcl

vivado-mcp uninstall [path]

从 Vivado_init.tcl 移除

vivado-mcp doctor [path] [--port 9999] [--json]

只读检查环境与连接

vivado-mcp doctor --fix [--client all|claude-code|codex]

备份后修复可安全自动处理的配置

vivado-mcp skills list [--json]

查看随包分发的五项工作流与 Prompt 映射

vivado-mcp skills export DEST [--skill NAME]

导出到指定目录;保留已有修改,不自动配置客户端

vivado-mcp version

显示版本

开发

git clone https://github.com/mapleleavessssssss-wq/vivado-mcp.git
cd vivado-mcp
python -m pip install -e ".[dev]"

# 运行测试(不需要 Vivado)
pytest

# 代码检查
ruff check src/ tests/

反馈与 Bug 提交

通过 Code Agent 提交 Bug

遇到问题?把下面的 prompt 复制到你的 agent(Claude Code、Cursor、Codex 等)中,它会自动收集环境信息并创建规范的 issue:

我在使用 vivado-mcp (https://github.com/mapleleavessssssss-wq/vivado-mcp) 时遇到了问题。

请帮我提交一个 GitHub issue,按以下步骤操作:

1. 收集我的环境信息:
   - 操作系统: 运行 `[System.Environment]::OSVersion.VersionString`(PowerShell)或 `systeminfo | findstr /B /C:"OS"`(cmd)
   - Python 版本: 运行 `python --version`
   - vivado-mcp 版本: 运行 `vivado-mcp version`(或 `pip show vivado-mcp`)
   - Vivado 版本: 运行 `vivado -version`(若 vivado 在 PATH 中);否则从我项目的 .xpr 文件里抓 Project 标签
   - 当前 Vivado 进程: PowerShell 跑 `Get-Process | Where-Object { $_.ProcessName -like "*vivado*" }`
   - MCP 客户端类型(Claude Code / Cursor / Codex 等)及版本
   - 我使用的 Vivado 模式(`gui` / `tcl` / `attach`)

2. 询问我:
   - 期望的行为是什么
   - 实际发生了什么
   - 复现步骤(从 `start_session` 开始的完整工具调用序列)
   - 相关的工具输出 / 错误日志(优先 `get_critical_warnings` 或 `get_run_progress` 的输出)

3. 使用 `gh issue create` 在 GitHub 上创建 issue,格式如下:
   - 标题: 简洁的问题概述,前缀建议 `[bug]` / `[feature]` / `[docs]`
   - 正文包含以下部分: **环境信息**、**问题描述**、**复现步骤**、**期望行为 vs 实际行为**、**相关日志**
   - 如果是 bug 请添加 `bug` 标签;如果涉及特定工具(如 `get_critical_warnings`),在标题里点出来

仓库: mapleleavessssssss-wq/vivado-mcp

直接提 issue

也可以直接到 GitHub Issues 提交 —— 麻烦带上 vivado-mcp version、Vivado 版本、复现步骤。

文档

许可证

Apache License 2.0

Available Tools

32 tools
check_bitstream_readinessA

检查比特流生成前的实现状态、时序摘要和严重警告。

这个工具是"发车前的最后一瞥":在你打算 generate_bitstream 或 program_device 之前,一次性给出 PASS/BLOCK/WARN 的综合结论,避免烧板后才发现问题。

检查维度:

  • impl_1 run 是否已到达 route_design Complete(没布线 = 无法生成比特流)

  • route 后的 CRITICAL WARNING 数量(> 0 通常意味着潜在功能风险)

  • 时序是否收敛(WNS/WHS 是否 met)

返回结论:

  • READY:本次有限检查通过;不证明完整签核或硬件功能

  • BLOCK:存在阻塞性问题(route 未完成 / 时序违例 / 大量 CW)

  • WARN:可以生成但有风险(少量 CW 或估算时序偏低)

Args: impl_run: 实现 run 名称,默认 "impl_1"。 session_id: 目标会话 ID。

Inputs: impl_run, session_id. Returns: result

compare_xciA

对比两个 XCI 文件的 IP 配置差异。

无需 Vivado 会话,直接读取 XML 文件对比参数。 适用于版本对比、不同板卡间配置迁移验证、调试 IP 参数差异。

Args: file_a: 第一个 XCI 文件路径(如基准/正常配置)。 file_b: 第二个 XCI 文件路径(如待检查/异常配置)。 show_all: 是否显示所有参数(默认仅显示差异)。

Inputs: file_a (required), file_b (required), show_all. Returns: result

generate_bitstreamA

生成比特流文件。在实现完成后执行。

默认启用前置安全检查:检测 CRITICAL WARNING 后阻止生成, 需确认无风险后使用 force=True 跳过检查。

Args: impl_run: 实现 run 名称,默认 "impl_1"。 jobs: 并行任务数,默认 4。 timeout_minutes: 超时分钟数,默认 30。 force: 跳过 CRITICAL WARNING 安全检查,默认 False。 session_id: 目标会话 ID。

Inputs: jobs, force, impl_run, session_id, +1 more. Returns: result

get_cdc_reportA

解析 CDC 报告,按时钟对、严重级别和规则计数并返回有界明细 JSON。

现场执行 report_cdc -details -return_string;离线读取原始 UTF-8 报告。 计数单位为报告检查项,摘要与明细不重复累加,不能当总线位/端点数。 未验证完整时钟/IO 约束覆盖,默认报告可能隐藏豁免;signoff 始终 false, 空结果或 All paths are Safely Timed 不代表 CDC clean。本工具不修改约束。

Args: session_id: 现场查询会话 ID。 report_file: 可选本地原始 report_cdc -details 文本,最多 16 MiB,无需会话。 max_details: 返回明细上限,0..500;超过上限仍统计完整输入并明确截断。

Inputs: session_id, max_details, report_file. Returns: result

get_critical_warningsA

提取并分类 CRITICAL WARNING / ERROR / 非标错误,统一失败诊断入口。

解析指定 run 的 runme.log,按 warning ID 聚合分类,返回中文诊断报告。 包含已知 warning 的分类标签和修复建议。

三种诊断模式根据 run_name 自动选择:

  1. synth_* / impl_* 等综合实现 run:走原流程(runme.log 解析 ERROR/CRITICAL WARNING)。额外:errors=0 且 cw=0 但 STATUS 含 ERROR 时, 自动 tail runme.log 最后 N 行扫非标错误关键词(TclStackFree / segfault / FATAL 等不带 ERROR: 前缀的内部异常),解决"messageDb 显示干净但 run 实际 崩了"的盲区。

  2. sim_* simulation fileset:改去 tail <proj>.sim/<sim_fs>/*/xsim/*.log (Vivado launch_simulation 的真错误位置,不在 runme.log),扫非标 关键词,自动暴露 xvlog 未找到等子进程错误。

  3. 任何 run:无论结果如何,都会静默把本次 CW 列表写快照(存到项目目录 .vmcp/ 下, 或 fallback 到 ~/.claude/vivado-mcp/)。启用 compare_with_last=True 时, 读上次快照与本次对比,报告消除/新增/仍存在的条目。(sim 模式不写快照)

Args: run_name: run / fileset 名称(如 synth_1 / impl_1 / sim_1), 默认 impl_1。sim_* 走 simulation 日志诊断路径。 compare_with_last: True 时追加一段与上次快照的差分报告(仅对综合/实现有效)。 tail_n: 非标错误扫描时每个日志 tail 的末尾行数,默认 50,范围 1~500。 仿真模式适用于每个 xsim 子日志。 session_id: 目标会话 ID。

Inputs: tail_n, run_name, session_id, compare_with_last. Returns: result

get_io_reportA

获取结构化 IO 引脚报告(JSON)。

执行 report_io 并解析为结构化数据,包含:

  • 每个端口的引脚、站点、方向、IO 标准、Bank

  • GT / GPIO 类型自动判定

  • 汇总统计(总数、GT 数、GPIO 数、未分配数)

Args: session_id: 目标会话 ID。

Inputs: session_id. Returns: result

get_ip_statusA

检查项目中所有 IP 的版本状态(哪个需要升级、哪个已锁定)。

老项目打开后 Vivado 常提示"N 个 IP 需要升级"。这个工具一次性列出:

  • 需要升级的 IP(Vivado 更新了更好的版本)

  • 已锁定的 IP(IS_LOCKED 属性为 TRUE,改动需先解锁)

  • 已最新的 IP

附带升级建议(单个升级 / 全部升级 / 升级后验证)。

Args: session_id: 目标会话 ID。

Inputs: session_id. Returns: result

get_next_suggestionA

根据当前项目状态推断下一步应该做什么。

适合新手、刚打开老项目、或者不知道从哪下手的场景。规则:

  • 没项目 → 建议 open_project / create_project

  • 有项目没源文件 → 建议 add_files

  • 没顶层 → 建议 set_property TOP

  • 没 XDC → 建议添加约束

  • 有 testbench 且没跑过行为仿真 → 先 launch_simulation

  • 可综合 → xdc_lint + run_synthesis

  • 综合完成 → run_implementation

  • 布线完成 → check_bitstream_readiness + generate_bitstream

  • 比特流就绪 → program_device

  • 任何阶段失败 → 引导到 get_critical_warnings

Args: session_id: 目标会话 ID。

Inputs: session_id. Returns: result

get_pre_commit_summaryA

生成一段可以贴进 git commit body 的工程摘要(时序/资源/CW)。

典型用途:做完 RTL 改动、跑完 impl 之后,想把关键数字写进 commit body, 避免 "改了 UART 模块" 这种无信息量的 commit。本工具一次性采样:

  • 项目 + part + 顶层

  • 时序摘要(WNS / WHS / 失败端点数)

  • 资源占用(LUT / FF / BRAM / DSP / IOB 百分比)

  • CW / ERROR 计数(若有 impl_run)

  • 综合生成 READY/WARN/FAIL 门禁标签

输出为 markdown 片段,直接粘贴到 commit 描述。

Args: impl_run: 用来查 runme.log 计数的 run(默认 impl_1)。 session_id: 目标会话 ID。

Inputs: impl_run, session_id. Returns: result

get_project_infoA

获取当前 Vivado 项目的综合信息(项目名 / part / 顶层 / 文件列表 / IP / run 状态)。

一次查询完成"摸底":AI 接手陌生项目时的起点。包含:

  • 项目名称、目录、Part 型号、顶层模块

  • 所有源文件(按类型分组)

  • XDC 约束文件列表

  • IP 实例列表(含 VLNV)

  • synth_1 / impl_1 的当前状态

Args: session_id: 目标会话 ID。

Inputs: session_id. Returns: result

get_run_progressA

查看 run 的运行进度(适合长任务等待时看"走到哪一步")。

综合或实现常跑 10-30 分钟,这个工具让你不用开 GUI 就能看到:

  • 当前状态(running / complete / error)与 PROGRESS 百分比

  • runme.log 里最近若干条 Phase 行(Phase 1 → Phase 2.1 → Phase 3 ...)

  • 日志尾部 N 行(含最新 WARNING / CRITICAL WARNING 原文)

  • 日志最后更新时间(判断 Vivado 是否还在活跃)

Args: run_name: run 名称(如 "synth_1" / "impl_1"),默认 "impl_1"。 tail_lines: 日志尾部要读多少行,默认 30。 session_id: 目标会话 ID。

Inputs: run_name, session_id, tail_lines. Returns: result

get_timing_reportA

获取结构化时序报告。

执行 report_timing_summary 并解析为结构化摘要 + 关键路径详情。 默认返回中文摘要;JSON 模式返回可保存的版本化证据。report_file 可离线 读取 UTF-8 Vivado 原始报告,无需会话。基线比较只给上下文匹配的观察差值, 不证明约束等价或完整签核;本工具不写文件。

Args: session_id: 目标会话 ID。 output_format: text(默认)或 json;json 模式错误也返回 JSON。 report_file: 可选原始时序报告路径,最多 16 MiB;不是 JSON 快照。 baseline_file: 可选之前保存的完整 JSON 返回值路径,最多 4 MiB。

Inputs: session_id, report_file, baseline_file, output_format. Returns: result

get_utilization_reportA

获取资源占用摘要(LUT/FF/BRAM/DSP/IO)。

执行 report_utilization -return_string 并从多个表格里抽取核心资源行, 高亮超过 90% 占用的 [CRITICAL] 项和 70-90% 的 [WARN] 项。

典型用途:

  • 综合后检查"LUT 够不够 / BRAM 够不够"

  • 时序收敛困难时先看资源是否超限(> 90% 会导致拥塞)

  • detail=True 进一步看 BRAM 由 RAMB36 还是 RAMB18 组成(优化位宽/级联时用)

Args: detail: True 时末尾附加 Block RAM 明细段(RAMB36/FIFO* / RAMB36E1 only / RAMB18 的 used/available)。默认 False,输出与原有格式一致。 session_id: 目标会话 ID。

Inputs: detail, session_id. Returns: result

inspect_ip_paramsA

查询 IP 实例的所有配置参数(含 GUI 中隐藏的参数)。

通过 Vivado Tcl API 获取指定 IP 的所有 CONFIG.* 属性及其当前值。 支持按关键词过滤(如 "gt"、"loc"、"lane"),不区分大小写。

Args: ip_name: IP 实例名称(如 "xdma_0")。 filter_keyword: 可选过滤关键词(如 "gt"、"loc"、"lane"),不区分大小写。 session_id: 目标会话 ID。

Inputs: ip_name (required), session_id, filter_keyword. Returns: result

list_sessionsA

列出所有活跃的 Vivado 会话及其状态。

Inputs: no named parameters. Returns: result

parse_bit_headerA

离线解析 .bit 比特流文件头部,无需启动 Vivado。

只读文件头(不读 payload):提取设计名 / 目标 part(原始 + 规整)/ 构建日期时间 / 文件 SHA256。用于烧录前防错板(part 比对)、交付/返修对账(确认孤立 .bit 是不是 声称的那版)。Vivado 无任何 Tcl 命令读离线 .bit。 注意:.bit 里 part 去 'xc' 前缀 + 去速度等级(如 7k325tffg900);规整字段补回 'xc' 但速度等级无法还原,与 .xpr 的 part 比对时只能比到 package 级。

Args: file_path: .bit 文件的绝对路径。

Inputs: file_path (required). Returns: result

parse_ltxA

离线解析 ILA 调试探针文件(.ltx),无需连板 / 启动 Vivado。

连板 ILA 抓波前先离线拿清单:每个 hw_ila 挂哪些 probe、probe 名、位宽、映射的 net。辅助在写 set_property TRIGGER_COMPARE_VALUE eq<位宽>'h.. [get_hw_probes ] 之前确认正确的 probe 名和宽度。get_hw_probes 需板子在手 + 活 hw session,本工具完全离线。Vivado 2019.1 的 .ltx 是 JSON 格式。

Args: file_path: .ltx 文件的绝对路径。

Inputs: file_path (required). Returns: result

parse_xprA

离线解析 Vivado 工程文件(.xpr),无需启动 Vivado。

秒级摸底陌生工程 / CI 门禁:不启 Vivado(避开 120s GUI 冷启 + 中文路径 TclStackFree 崩),纯 Python 读 .xpr 拿 part / 顶层 / 源文件(按 fileset 分组, 含 .v/.mem/.xci IP)/ XDC 约束 / synth+impl runs 及 Strategy。 对照 get_project_info(需先 start_session + open_project),本工具完全离线。

Args: file_path: .xpr 工程文件的绝对路径。

Inputs: file_path (required). Returns: result

program_deviceA

编程 FPGA 设备。封装 open_hw_manager → connect → program 多步操作。

只烧 .bit 进 FPGA(掉电即丢)。要掉电自启动须烧 SPI flash,见下面配方。

烧 flash 配方(2019.1,run_tcl 逐步执行):

  1. 查 flash 型号: get_cfgmem_parts -of [lindex [get_hw_devices] 0] (或按板上 flash 用 -filter 选,如 mt25ql128-spi-x1_x2_x4)

  2. 生成 .mcs: write_cfgmem -format mcs -size 16 -interface SPIx4 -loadbit {up 0x0 <top>.bit} -force out.mcs

  3. 建 cfgmem 对象: create_hw_cfgmem -hw_device [current_hw_device] [lindex [get_cfgmem_parts <part>] 0]

  4. 设属性四件套: set_property PROGRAM.FILES {out.mcs} [current_hw_cfgmem]

    • PROGRAM.ERASE 1 / PROGRAM.CFG_PROGRAM 1 / PROGRAM.VERIFY 1

  5. 烧写: program_hw_cfgmem

  6. 烧后 boot_hw_device [current_hw_device] 或断电重启从 flash 加载。 (Zynq 用 .bin: write_cfgmem -format bin -interface SMAPx32 ...)

Args: bitstream_path: 比特流文件路径(.bit 文件)。 target: 目标设备过滤器,默认 "*"(第一个可用设备)。 hw_server_url: 硬件服务器地址,默认 "localhost:3121"。 session_id: 目标会话 ID。

Inputs: bitstream_path (required), target, session_id, hw_server_url. Returns: result

query_waveformA

离线发现 VCD 信号或查询有界波形变化,返回 JSON。

无需 Vivado 会话。仅 .vcd,最大 32 MiB,不支持 FST/WDB。 event/real/string 可发现但不可查询,event 瞬时触发不能视为持久逻辑位。 返回 timescale 与整数 ticks;同一时间戳更新合并,initial_values 是 start_time 全部更新后的值,events 是之后的变化。条件查询返回 matches, equals/unknown/all_equals 也检查初值,change 仅检查之后的变化。 scan_truncated/result_truncated 表示扫描/结果不完整,不能据此断言无异常; simulation_verdict 始终为 not_evaluated。

Args: file_path: 本地 VCD 文件路径。 signals: 最多 32 个精确层级路径,如 top.data;为空时发现信号/层级。 start_time: 非负整数 VCD tick,默认 0。 end_time: 包含此时刻的结束 tick,默认读到文件末尾。 max_events: 1..1000,变化/条件匹配上限,发现模式用作信号上限。 condition: 可选结构化条件,信号须已选中,位值为二进制字符串(可 x/z)。 {"op":"equals","signal":"top.data","value":"0001"}; {"op":"change","signal":"top.data"}; {"op":"unknown","signal":"top.data"}; {"op":"all_equals","values":{"top.valid":"1","top.ready":"1"}}。 不支持表达式、通配符或 eval;短位值按 VCD 宽度扩展。

Inputs: file_path (required), signals, end_time, condition, +2 more. Returns: result

run_implementationA

启动实现(布局布线);默认等待完成,也可异步提交。

不调用 Tcl wait_on_run(会阻塞 Vivado event loop,GUI 模式冻住界面); wait=True 时 Python 每 2 秒查一次 STATUS/PROGRESS;wait=False 时立即 返回 job_id,随后用 get_run_progress 查询。

Args: run_name: 实现 run 名称,默认 "impl_1"。 jobs: 并行任务数,默认 4。 timeout_minutes: 超时分钟数,默认 60。 session_id: 目标会话 ID。 wait: True 等待完成并诊断;False 启动后立即返回 job_id。

Inputs: jobs, wait, run_name, session_id, +1 more. Returns: result

run_synthesisA

启动综合;默认等待完成,也可异步提交后查询状态。

不调用 Tcl wait_on_run(会阻塞 Vivado event loop,GUI 模式冻住界面); wait=True 时 Python 每 2 秒查一次状态并上报进度;wait=False 时立即 返回 job_id,随后用 get_run_progress 查询。

Args: run_name: 综合 run 名称,默认 "synth_1"。 jobs: 并行任务数,默认 4。 timeout_minutes: 超时分钟数,默认 30。 session_id: 目标会话 ID。 wait: True 等待完成并诊断;False 启动后立即返回 job_id。

Inputs: jobs, wait, run_name, session_id, +1 more. Returns: result

run_tclA

执行任意 Vivado Tcl 命令。支持所有 Vivado Tcl API。

这是最通用的工具,可以执行任何 Vivado Tcl 命令,包括:

  • 项目: create_project, open_project, add_files, set_property top

  • 约束: create_clock, set_property PACKAGE_PIN

  • IP: create_ip, generate_target, set_property CONFIG.*

  • Block Design: create_bd_design, create_bd_cell, connect_bd_intf_net

  • 查询: get_ports, get_cells, get_property STATUS [get_runs]

  • 报告: report_utilization -return_string, report_timing_summary -return_string

  • 仿真: launch_simulation, run 100ns, add_wave

  • 以及任何其他 Vivado Tcl 命令

支持多行脚本(用换行符分隔)。

路径含特殊字符时请用 safe_tcl 而非 run_tcl,避免 Tcl 解析错误。

XSim 仿真常见坑摘要(0.3.17 实战沉淀,下面即完整清单):

  • add_wave_group 必须配 -into $g,否则信号全跑到顶层,group 是空的:

    set g [add_wave_group sig_grp]
    add_wave -into $g /tb/clk     ;# ✓ 进 group
    add_wave /tb/rst              ;# ✗ 跑到顶层
  • add_wave / get_objects 拒 escaped id,必须先 current_scope 切到目标 scope 再用 short name:

    # ✗ add_wave {\u_dut/sig}
    current_scope /tb/u_dut       ;# ✓ 切上下文
    add_wave sig
  • get_scopes 不支持多 path 参数,一次只能查一个 scope,多个要 foreach 逐个:

    # ✗ get_scopes /tb/u_dut /tb/u_ctrl
    foreach __p {/tb/u_dut /tb/u_ctrl} { puts "$__p: [get_scopes $__p]" }
  • size > 1 filter 对 escaped id 总线对象无效且不报错(其 size 属性可能 =1,静默漏数据)。筛总线别依赖 size,改用 regexp NAME 匹配 \[.*:.*\] 总线命名约定。

  • 清空波形只认 remove_wave [get_waves *],-all / * / -of_objects 都 不工作(XSim 2019.1 bug)

  • xsim -tclbatch 文件必须显式 quit,EOF 不自动退出,会卡死 CI

  • if-generate 命名块不是 scope —— 内部 reg 无 add_wave 寻址路径

  • [N] / [X] 在 Tcl 字符串里会触发命令替换,用 {} 包字面路径:

    # ✗ add_wave /tb/gen_ch[0].u/sig    invalid command "0"
    add_wave {/tb/gen_ch[0].u/sig}
  • marker 复位 = 磁盘 wcfg 干净时重载。marker 存在 .wcfg 的 <wave_markers><marker time="..fs"/></wave_markers>,清掉/复位用一行:

    close_wave_config -force          ;# 丢内存里的脏 marker
    open_wave_config C:/path/wave.wcfg ;# 从干净磁盘文件重载

set_property / radix 写脚本陷阱(0.3.20 实战沉淀,无 err 静默踩):

  • -filter "name =~ {...[$var]...}" 会污染后续 set_property 静默失败。 [$var] 触发 Tcl 命令替换,虽然 get_scopes 内部 fallback 仍返回正确对象, 但污染后续 wave property 路径,set_property RADIX dec $w 静默不生效。 改用 foreach + regexp 自己过滤,绕开 filter 字符串里的 [$var]。

  • set_property RADIX value 大小写敏感(大多数 Vivado property 是大小写 不敏感的,这条是反直觉的例外):

    set_property RADIX dec $w   ;# ✓ RADIX=dec
    set_property RADIX DEC $w   ;# ✗ 静默退回 RADIX=default,不报错
  • add_wave -radix 和 set_property RADIX 接受的 value 集合不一致:

    add_wave -radix : default | dec | bin | oct | hex | unsigned | ascii | smag
    set_property RADIX: dec | hex(其他实测未通过;大写一律不接受)

    signed decimal 在 XSim 叫 dec,不是 signed(从 ModelSim/QuestaSim 带过来的命名习惯会踩)。

  • Analog 波形可纯 Tcl 渲染(早期文档误判"无 Tcl 接口"的真根因)。 WaveformStyle 不在 list_property $w / set_property 全集里,要用专用命令 set_wave_prop。当年踩坑是因为值写成了裸 ANALOG——Vivado 收下不报错但 渲染器不认,只改属性值不渲染(静默接受陷阱)。正确值必须带 STYLE_ 前缀, 且信号寻址有两个静默坑(实测 2019.1):

    # ★ get_waves 按"显示名"(如 y0[15:0])/glob 匹配,传全路径 /tb/y0 返回空!
    #   且 set_wave_prop 对空对象 rc=0 静默接受 → 信号没 add 会伪装成功,务必先判空。
    set w [get_waves -quiet y0*]   ;# 用显示名/glob;或遍历 get_waves * 按 DESIGN_OBJECT 全路径过滤
    if {[llength $w]} {
      set_wave_prop WaveformStyle STYLE_ANALOG $w  ;# ★ 裸 ANALOG 静默吞值不渲染
      set_wave_prop AnalogMin -2048 $w             ;# 贴数据范围:太宽压平,太窄削顶
      set_wave_prop AnalogMax  2047 $w
      set_wave_prop AnalogInterpolation LINEAR $w
      set_property HEIGHT 80 $w                     ;# 存为 CellHeight
    }
    • 无法 Tcl 读回:get_wave_prop 不存在、report_wave_props 输出不可捕获, 设完只能人眼确认渲染(MCP set_wave_analog 工具已封装寻址 + STYLE_ 前缀)。

    • 重载冲掉 analog:先定好 zoom 再实时上 analog,别先改 analog 再 open_wave_config。

    • wcfg 磁盘路径属性是 FILE_PATH(不是 FILE_NAME,后者报 [Common 17-54]): get_property FILE_PATH [current_wave_config](MCP set_wave_zoom 改 zoom_setting 用此)。

Args: command: Tcl 命令文本(支持多行)。 session_id: 目标会话 ID,默认 "default"。 timeout: 命令执行超时秒数,默认 120。注意超时语义:超时只是 MCP 停止 等待并返回错误,命令在 Vivado 里仍在继续跑(不会被取消),后续 命令会排队等它跑完。长任务(综合/实现/比特流)请改用 run_synthesis / run_implementation / generate_bitstream (Python 轮询不阻塞),或按预期耗时调大本值。

Inputs: command (required), timeout, session_id. Returns: result

safe_tclA

执行带参数的 Tcl 命令模板,自动用 Tcl list 规则转义参数。

适用场景:命令中含文件路径、端口名、字符串值等可能有特殊字符的输入。 Tcl 的 $、[]、{}、反斜杠、空格都会被正确转义,防注入且防解析错。

用法示例:

  • safe_tcl("create_project {0} {1} -part {2}", args=["my_proj", "C:/path with space", "xc7a35tcpg236-1"])

  • safe_tcl("read_verilog {0}", args=["C:/files/top with $dollar.v"])

  • safe_tcl("set_property PACKAGE_PIN {0} [get_ports {1}]", args=["W5", "clk"])

template 用 Python format 的 {0} / {1} 占位符,args 中每个元素会被 tcl_quote() 包装成 "..." 并转义所有特殊字符。

Args: template: Tcl 命令模板,用 {0}/{1}/... 表示参数位置。 args: 参数值列表,将被自动转义。 session_id: 目标会话 ID,默认 "default"。 timeout: 命令执行超时秒数,默认 120。

Inputs: template (required), args, timeout, session_id. Returns: result

set_wave_analogA

把信号设为模拟(Analog)波形显示(纯 Tcl 配方,实测 Vivado 2019.1 可渲染)。

本地价值(§1.3 条件2 本地知识库,三个实测静默坑):

  1. WaveformStyle 必须传 STYLE_ANALOG(带 STYLE_ 前缀);裸传 ANALOG 时 Vivado 收下 不报错但渲染器不认,只显示数字格。推翻早期"Analog 无 Tcl 接口只能 GUI 右键"的误判。

  2. get_waves 只匹配显示名(y0[15:0])/glob,直接传全路径 /tb/y0 返回空;工具自动按 DESIGN_OBJECT(全路径)/FULL_NAME/显示名解析,不命中才报 add_wave。

  3. set_wave_prop 对空对象 rc=0 静默接受(信号没 add 会伪装成功),工具先判空再 set。 wave 属性无 get 接口(get_wave_prop 不存在),无法 Tcl 读回校验,渲染请人眼确认。

⚠ 顺序硬约束:必须在 set_wave_zoom 之后调——zoom 重载(close+open wcfg)会冲掉 先设的 analog prop。 ⚠ AnalogMin/Max 必须成对显式传(贴数据范围:太宽压平、太窄削顶)。从仿真数据 自动算幅需 live 采样、数据源未定,本版本不做 auto。

Args: signals: 信号列表(短名或全路径,须已 add_wave 进波形)。 min: AnalogMin(必传,与 max 成对)。 max: AnalogMax(必传,与 min 成对)。 interp: 插值方式,白名单 LINEAR / HOLD。 height: 行高像素(存盘后在 wcfg 里叫 CellHeight)。 session_id: 目标会话 ID。

Inputs: signals (required), max, min, height, +2 more. Returns: result

set_wave_zoomA

设置波形时间缩放窗口(改 wcfg XML 后 close -force + open 重载)。

本地价值(§1.3 条件3 跨命令协议):Vivado 2019.1 无 Tcl zoom 命令,缩放窗存在 .wcfg 的 <zoom_setting> 里,要改它再让 XSim 重载。重载顺序极易踩—— close 漏 -force 报 [Wavedata 42-26];同名 wcfg 已 open 时直接 open 报 42-52, 故必须先 close 再 open。本工具封装这条多步协议。

⚠ wcfg 未保存(current_wave_config 的 FILE_PATH 为空)时返回明确错误,要求先 save_wave_config——不自动存盘(避免擅自改用户磁盘文件)。 ⚠ close_wave_config -force 会丢弃所有未存盘的 live wave prop(含手设的 radix/ analog),故先 set_wave_zoom 再 set_wave_analog。

Args: start_ns: 缩放起始时间(ns),须 < end_ns。 end_ns: 缩放结束时间(ns)。 wcfg: 显式 wcfg 磁盘路径;缺省自动解析 current_wave_config。 session_id: 目标会话 ID。

Inputs: end_ns (required), start_ns (required), wcfg, session_id. Returns: result

start_sessionA

启动一个新的 Vivado 会话。

三种模式:

  • "gui" (默认) — MCP 自动 spawn vivado -mode gui,你能看到 Vivado 图标 并实时观察 Tcl Console / Block Design / 波形等 GUI 内容。首次使用会自动 通过 -source 注入 TCP server,或先运行一次 vivado-mcp install 持久化。

  • "tcl" — vivado -mode tcl 无头子进程(无 GUI,适合 CI / 批处理)。

  • "attach" — 连接到用户已手动打开的 Vivado GUI(需先运行 vivado-mcp install 让 init.tcl 自动开启 TCP server)。

每个 session_id 对应一个独立的会话句柄;同 session_id 再次调用会复用现有会话 (会话模式自动复用)。多开独立 GUI 实例见下方 port 说明。

Args: session_id: 会话标识符,默认 "default"。 mode: "gui" / "tcl" / "attach",默认 "gui"。 port: TCP 端口语义(B 方案): - gui 默认 9999:先 probe 9999,命中现有 vmcp server 则直接复用/ attach(单 GUI 自动复用,也避免抢端口产生孤儿);无则 spawn 并绑 9999。 - 多开独立实例:传 port=0 自动分配一个空闲端口启动全新实例(零手动 配端口、跳过 probe),或给不同端口的显式值。注意:不传 port 时即便换 session_id 也会 probe/attach 到 9999 的同一个 GUI(不会自动多开),要独立 实例就传 port=0 或显式不同端口。 - attach 模式:要连接的现有 GUI 的显式端口(默认 9999)。 vivado_path: 可选,自定义 Vivado 可执行文件路径。留空则自动检测。 timeout: 启动超时秒数,GUI 模式建议 120+。默认 120。

Inputs: mode, port, timeout, session_id, +1 more. Returns: result

stop_sessionC

关闭指定的 Vivado 会话。

Args: session_id: 要关闭的会话标识符。

Inputs: session_id. Returns: result

verify_io_placement_toolA

验证 IO 引脚分配:比对 XDC 约束与实际布局。

自动读取项目 XDC 文件中的 PACKAGE_PIN 约束(支持 -dict 和传统两种语法), 与 report_io 的实际分配结果对比,发现 GT 引脚交叉等严重错误。

GT 端口不匹配标记为 CRITICAL,GPIO 端口标记为 WARNING。

Args: session_id: 目标会话 ID。

Inputs: session_id. Returns: result

verilog_compile_checkA

用 iverilog / verilator 做 Verilog 语法 + 连接性检查(比 Vivado 综合快 50 倍)。

典型用途:写完或改完 RTL 想在几秒内确认"能不能过综合",不用等 30-60s Vivado。 需要机器上装 iverilog 或 verilator: Windows: scoop install iverilog / choco install verilator Linux: apt install iverilog / apt install verilator macOS: brew install icarus-verilog / brew install verilator

检查模式:

  • iverilog -t null:只做 parse + elaboration,不产物

  • verilator --lint-only -Wall:静态检查,风格警告也给(更严格)

未装任何工具时返回 SKIP 并附安装指引,不报错。

Args: files: Verilog / SystemVerilog 文件路径列表(.v / .sv)。 .vhd/.vhdl 不支持,返回 SKIP 并附替代方案指引(check_syntax)。 tool: "auto"(默认,优先 iverilog) / "iverilog" / "verilator"。 timeout: 子进程超时秒数,默认 30。

Inputs: files (required), tool, timeout. Returns: result

xdc_auto_fixA

自动修复 XDC 文件中能安全自修的问题(MISSING_IOSTANDARD / CLOCK_NO_PERIOD)。

默认 dry_run=True 只预览补丁,确认无误后调用 dry_run=False 实际写回。 写回前会为每个被修改文件生成同名 .bak 备份;注意 .bak 只保留最近一次 修改前的版本(再次写回会覆盖上一次的 .bak,与 sed -i.bak 同语义)。

只修这两类问题(其他需要人工判断):

  • MISSING_IOSTANDARD —— 在 PACKAGE_PIN 行之后插入 IOSTANDARD 语句

  • CLOCK_NO_PERIOD —— 仅当 board 已知时补 -period;未知板跳过

绝对不碰:

  • PIN_CONFLICT / DUPLICATE_PORT / PIN_CONFLICT_CROSS_FILE(冲突问题必须人改)

Args: xdc_paths: XDC 文件路径列表。不传则从当前 session 的项目里抓。 board: 板卡名,影响默认 IOSTANDARD 和时钟周期。支持: basys3 / nexys-a7 / arty-a7 / zybo / kc705。留空用 LVCMOS33 兜底。 dry_run: True(默认)只输出补丁预览不改文件;False 实际写回。 session_id: 目标会话 ID(仅在不传 xdc_paths 时使用)。

Inputs: board, dry_run, xdc_paths, session_id. Returns: result

xdc_lintA

对 XDC 约束文件做静态检查(pure Python,不依赖 Vivado 综合)。

综合前就能捕到这些常见错误,省掉 30+ 秒的跑综合等待:

  • PIN_CONFLICT:同一物理引脚被多个 port 占用

  • MISSING_IOSTANDARD:有 PACKAGE_PIN 却没配 IOSTANDARD(NSTD-1 / BIVC-1 隐患)

  • DUPLICATE_PORT:同 port 被多次约束不同引脚(后者覆盖)

  • CLOCK_NO_PERIOD:create_clock 缺 -period

  • PIN_CONFLICT_CROSS_FILE:多个 XDC 文件间的引脚冲突

Args: xdc_paths: 要检查的 XDC 文件路径列表。若不传,则从当前 session 的项目里 自动抓取所有 constrs_1 下的 XDC 文件。 session_id: 目标会话 ID(仅在不传 xdc_paths 时使用)。

Inputs: xdc_paths, session_id. Returns: result

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.8/5.0

    Scored across 32 tools

    Disambiguation3/5

    Most tools have distinct purposes (reports, runs, XDC, offline parsers), but there is noticeable overlap in the Tcl execution family: run_tcl and safe_tcl are similar, several offline parsers (parse_xpr, parse_bit_header, parse_ltx, compare_xci, inspect_ip_params) all deal with file/design inspection, and both get_run_progress and run_synthesis/run_implementation with wait=False can monitor progress. The descriptions do clarify the differences, but an agent could confuse safe_tcl/run_tcl or the various parsing tools in a hurry.

    Naming Consistency4/5

    The naming is mostly consistent with verb_noun patterns: get_*, run_*, parse_*, set_*, check_*, compare_*, inspect_* are all clear and predictable. Minor deviations exist: safe_tcl and run_tcl don't follow the verb_noun pattern as strictly, and the three waveform tools (query_waveform, set_wave_zoom, set_wave_analog) are a mixed set, but overall the naming is very readable and predictable.

    Tool Count3/5

    At 32 tools, this is on the heavy side for an MCP server. The variety of Vivado workflows (project management, synthesis, implementation, constraints, IP, waveform, offline analysis) justifies many of them, but a few are marginal (e.g., get_io_report vs verify_io_placement_tool, get_pre_commit_summary feels like a convenience utility). It's pushing into 'too many' territory but still coherent overall.

    Completeness4/5

    The server covers the major Vivado workflows well: project info, constraint checking/fixing, synthesis/implementation/bitstream/programming, reports, IP inspection, offline file parsing, and session management. Minor gaps exist: there's no dedicated simulation launch/run tool (covered only via run_tcl examples), no block design CRUD tools, and IP creation/configuration relies on raw run_tcl. The get_next_suggestion tool attempts to stitch the workflow together, which helps cover gaps.

    Maintenance

    ActivityNo data
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers

    • F
      license
      C
      quality
      D
      maintenance
      An AI-centric MCP server that enables automated Xilinx Vivado workflows, including project management, synthesis, implementation, and timing analysis. It allows AI agents to drive hardware design processes while integrating directly with the official Vivado GUI for visual context.
      15
      4
      -
    • A
      license
      Not graded
      quality
      D
      maintenance
      MCP server for deterministic Vivado FPGA automation including project scaffolding, simulation, synthesis, implementation, and gated bitstream generation.
      4
      MIT
    • F
      license
      B
      quality
      D
      maintenance
      A Model Context Protocol server that lets AI clients operate AMD Vivado through safe, workflow-level tools while allowing the user to watch and interact with the Vivado GUI.
      21
      1
      -