Vivado MCP Native MCP server | MCP DirectoryFrom the publisher
Documentation
Vivado MCP Native 是一个面向 AMD/Xilinx Vivado 的本地 Model Context Protocol(MCP)服务器。它通过持久化 Vivado Tcl 会话,让 AI 客户端能够打开工程、运行综合与实现、生成比特流、读取时序和资源报告、控制仿真,并执行高级 Tcl 命令。
项目使用 Python subprocess 原生管理 Vivado 进程,可直接运行于 Windows 和 Linux,不依赖仅适用于类 Unix 环境的 pexpect。MCP 与 Vivado 都运行在用户本机,工程文件不会因为使用本项目而自动上传到云端。
[!IMPORTANT]
本项目不包含 Vivado。可用器件、IP、综合/实现功能和许可证能力,取决于本机安装的 AMD/Xilinx Vivado。
Native MCP server for controlling AMD/Xilinx Vivado on Windows and Linux via persistent Tcl.
VIVADO_PATH, VIVADO_MCP_OUTPUT_ENCODING[!WARNING]
PyPI 上的 vivado-mcp 属于另一个项目。本项目的安装包名称是 vivado-mcp-native。
它可以做什么
可以直接对 AI 这样说
启动 Vivado,并检查当前会话是否健康。
打开 D:\FPGA\my_project\my_project.xpr,告诉我目标器件、顶层模块和当前运行状态。
运行综合,使用 8 个并行任务。完成后汇总 ERROR、CRITICAL WARNING 和资源利用率。
分析当前设计的时序,告诉我 WNS/TNS 是否满足,并列出最差的 10 条 setup 路径。
只分析 clk_250m 时钟域中经过 u_tdc 的失败路径,并给出可能的优化方向。
运行实现并生成 bitstream;每一步都确认 Vivado 的真实 STATUS 和 PROGRESS。
启动行为级仿真,运行 1 us,然后读取 /tb/dut/data_out 和 /tb/dut/valid。
执行 Tcl:report_drc -ruledecks default,并总结需要优先处理的问题。
为什么使用这个项目
环境要求
安装
方式一:使用 pip 安装
py -m pip install --upgrade vivado-mcp-native
python3 -m pip install --upgrade vivado-mcp-native
py -m pip show vivado-mcp-native
vivado-mcp-native-doctor --help
方式二:使用 pipx 安装(推荐)
pipx 会为 MCP Server 创建独立 Python 环境,减少与其他 Python 包的依赖冲突。
py -m pip install --user --upgrade pipx
py -m pipx ensurepath
py -m pipx install vivado-mcp-native
python3 -m pip install --user --upgrade pipx
python3 -m pipx ensurepath
python3 -m pipx install vivado-mcp-native
py -m pipx upgrade vivado-mcp-native
方式三:直接从 GitHub 安装
py -m pip install --upgrade "git+https://github.com/Arthurzxy/vivado_mcp_native.git@master"
py -m pipx install --force "git+https://github.com/Arthurzxy/vivado_mcp_native.git@master"
不依赖本机 Git,也可以安装 GitHub ZIP:
py -m pip install --upgrade "https://github.com/Arthurzxy/vivado_mcp_native/archive/refs/heads/master.zip"
git clone https://github.com/Arthurzxy/vivado_mcp_native.git
cd vivado_mcp_native
py -m pip install -e .
安装后提供的命令
快速开始
第一步:确认 Vivado 启动文件
- 完整启动文件:
vivado.bat、vivado.cmd、vivado.exe 或 Linux vivado;
- Vivado 的
bin 目录;
- Vivado 版本目录。
$env:VIVADO_PATH = "D:\Software\Xilinx\2025.2.1\Vivado\bin\vivado.bat"
export VIVADO_PATH="/tools/Xilinx/Vivado/2025.2/bin/vivado"
未显式配置时,Server 会检查系统 PATH 和常见安装目录。
第二步:运行 Doctor
vivado-mcp-native-doctor --vivado-path "D:\Software\Xilinx\2025.2.1\Vivado\bin\vivado.bat"
vivado-mcp-native-doctor --vivado-path "D:\Software\Xilinx\2025.2.1" --json
- Vivado 启动文件解析;
- 持久 Tcl 会话启动;
- Vivado 和 Tcl 版本查询;
- Tcl 表达式执行;
- 中文 Unicode 往返;
- 会话健康状态;
- Vivado 正常关闭。
第三步:配置 MCP 客户端
(Get-Command vivado-mcp-native).Source
使用已安装的命令
把下面的 command 和 VIVADO_PATH 替换为你的实际路径:
{
"mcpServers": {
"vivado": {
"command": "C:\\Users\\you\\.local\\bin\\vivado-mcp-native.exe",
"env": {
"VIVADO_PATH": "D:\\Software\\Xilinx\\2025.2.1\\Vivado\\bin\\vivado.bat"
}
}
}
}
使用 Python 模块启动
适用于虚拟环境或 pip install 后不方便定位命令的情况:
{
"mcpServers": {
"vivado": {
"command": "C:\\Users\\you\\AppData\\Local\\Programs\\Python\\Python311\\python.exe",
"args": ["-m", "vivado_mcp"],
"env": {
"VIVADO_PATH": "D:\\Software\\Xilinx\\2025.2.1\\Vivado\\bin\\vivado.bat"
}
}
}
}
建议使用可执行文件的绝对路径,避免 MCP 客户端与终端使用不同 PATH。
配置保存后,完全退出并重新启动 MCP 客户端,然后让 AI 执行:
检查 Vivado MCP 的主机状态,启动会话并返回 Vivado 版本。
推荐使用流程
1. vivado-mcp-native-doctor 检查本机环境
2. start_session 启动持久 Vivado Tcl 会话
3. open_project 打开 .xpr 工程
4. get_project_info 确认器件、工程和顶层信息
5. run_synthesis 运行综合
6. get_messages 查看错误和警告
7. get_timing_summary 检查 WNS/TNS/WHS/THS
8. get_utilization 检查 LUT/FF/BRAM/DSP/IO
9. run_implementation 运行布局布线
10. get_timing_paths 分析最差路径
11. generate_bitstream 生成比特流
12. stop_session 关闭 Vivado 并释放资源
综合和实现可能耗时较长。大型工程应在调用时增加 timeout,并根据 CPU 和内存情况设置合适的 jobs。
MCP 工具说明
会话管理
start_session:启动持久 Vivado Tcl 会话;
stop_session:正常关闭 Vivado;
session_status:查看命令数、错误数和会话统计;
check_session_health:检查会话响应并按需恢复;
get_host_status:查看主机名、可用内存和会话状态。
工程与设计流程
open_project / close_project:打开或关闭 .xpr 工程;
get_project_info:获取当前工程信息;
run_synthesis:运行综合并验证 Vivado 的实际状态;
run_implementation:运行 place and route;
generate_bitstream:为已实现设计生成 bitstream。
报告与设计查询
get_timing_summary:返回 WNS、TNS、WHS、THS 等结构化指标;
get_timing_paths:按时钟、起点、终点或 through 对象过滤关键路径;
get_utilization:返回 LUT、FF、BRAM、DSP 和 IO 使用率;
get_clocks:获取时钟与约束信息;
get_messages:分类读取 ERROR、CRITICAL WARNING 和 WARNING;
get_design_hierarchy:读取综合后设计层次;
get_ports / get_nets / get_cells:查询端口、网络和单元。
仿真
set_simulation_top:设置 testbench 顶层;
launch_simulation:启动行为级或综合/实现后仿真;
run_simulation / step_simulation / restart_simulation:运行、步进或重启;
get_signal_value / get_signal_values:读取一个或一组信号;
get_scopes / get_simulation_objects:浏览仿真层次和对象;
add_signals_to_wave:添加波形信号;
add_breakpoint / remove_breakpoints:管理仿真断点;
get_simulation_messages:读取仿真日志;
close_simulation:关闭仿真。
高级能力
run_tcl:执行任意 Vivado Tcl;
generate_full_report:生成 timing、utilization、power、DRC 等完整报告;
read_report_section:按行范围或正则表达式读取大型报告;
request_feature / list_feature_requests:记录当前未覆盖的功能需求。
工作原理
Claude / Cursor / Cline / Cherry Studio / 其他 MCP 客户端
│
│ MCP stdio / JSON-RPC
▼
Vivado MCP Native
│
│ 持久 subprocess Tcl 会话
▼
AMD/Xilinx Vivado -mode tcl
│
▼
本机 FPGA 工程与报告
每条 Tcl 命令会使用 UTF-8 十六进制编码并附加唯一标记。Server 分别提取标准输出、Tcl 返回值、返回码和错误栈,不依赖可能随语言环境变化的 Vivado% 提示符。
常见问题
找不到 vivado-mcp-native 命令
py -m pipx ensurepath
(Get-Command vivado-mcp-native).Source
重启终端或把返回的绝对路径直接写入 MCP 客户端配置。
找不到 Vivado
& "D:\Software\Xilinx\2025.2.1\Vivado\bin\vivado.bat" -mode tcl
vivado-mcp-native-doctor --vivado-path "D:\Software\Xilinx\2025.2.1\Vivado\bin\vivado.bat"
中文输出乱码
$env:VIVADO_MCP_OUTPUT_ENCODING = "gbk"
可设置为 utf-8、gbk,或与本机 Vivado Tcl 控制台一致的编码。
综合或实现超时
超时后 Server 会终止完整 Vivado 进程树,防止继续使用已经失步的会话。重新启动会话,并为大型工程设置更长的 timeout。
vivado-mcp 和 vivado-mcp-native 是同一个包吗
py -m pip install vivado-mcp-native
安全说明
run_tcl 可以按当前用户权限执行任意 Tcl,包括读写文件和启动外部程序。请注意:
- 只连接可信的 MCP 客户端和模型;
- 执行删除文件、重置工程或覆盖输出前检查目标路径;
- 对重要工程使用版本控制并保留备份;
- 不要把没有鉴权和隔离的 Vivado MCP 直接暴露到公网。
官方 MCP Registry
io.github.Arthurzxy/vivado-mcp-native
贡献
欢迎通过 Issue 或 Pull Request:
- 补充新的 Vivado 工具;
- 改进不同 Vivado 版本的兼容性;
- 增强报告解析;
- 补充 MCP 客户端配置示例;
- 修正文档或翻译。
许可证与致谢
No tool list yet. Remote servers get one after the first health check.
How do I install Vivado MCP Native?
Copy the stdio config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.
Does Vivado MCP Native need an API key?
The publisher lists these environment variables: VIVADO_PATH, VIVADO_MCP_OUTPUT_ENCODING.
What transport does Vivado MCP Native use?
Vivado MCP Native runs locally over stdio.
When was Vivado MCP Native last checked?
Last checked 2026-11-08. Native MCP server for controlling AMD/Xilinx Vivado on Windows and Linux via persistent Tcl.