{ "markdown": "

\n 简体中文 | English\n

\n\n\n\n

Vivado MCP Native

\n\n

\n 让 Claude、Cursor、Cline、Cherry Studio 等兼容 MCP 的 AI 客户端
\n 在 Windows 和 Linux 上直接启动、控制并分析 AMD/Xilinx Vivado。\n

\n\n

\n \"PyPI\"/\n \"Python\"/\n \"Platform\"/\n \"MCP\n \"MIT\n

\n\n> **让 AI 处理 Vivado 的重复操作、报告读取和 Tcl 调用，你可以把精力放在 FPGA 架构、约束和问题判断上。**\n\nVivado MCP Native 是一个面向 **AMD/Xilinx Vivado** 的本地 Model Context Protocol（MCP）服务器。它通过持久化 Vivado Tcl 会话，让 AI 客户端能够打开工程、运行综合与实现、生成比特流、读取时序和资源报告、控制仿真，并执行高级 Tcl 命令。\n\n项目使用 Python `subprocess` 原生管理 Vivado 进程，可直接运行于 Windows 和 Linux，不依赖仅适用于类 Unix 环境的 `pexpect`。MCP 与 Vivado 都运行在用户本机，工程文件不会因为使用本项目而自动上传到云端。\n\n> [!IMPORTANT]\n> 本项目不包含 Vivado。可用器件、IP、综合/实现功能和许可证能力，取决于本机安装的 AMD/Xilinx Vivado。\n\n> [!WARNING]\n> PyPI 上的 `vivado-mcp` 属于另一个项目。本项目的安装包名称是 **`vivado-mcp-native`**。\n\n---\n\n## 它可以做什么\n\n| 类别 | 主要能力 | 典型用途 |\n|---|---|---|\n| Vivado 会话 | 启动、停止、健康检查、状态统计、异常恢复 | 让 AI 复用同一个 Vivado Tcl 进程，避免每条命令都重新启动 Vivado |\n| 工程管理 | 打开/关闭 `.xpr` 工程、读取工程信息 | 检查目标器件、顶层模块、工程目录和当前工程状态 |\n| 设计流程 | 运行综合、实现、生成比特流 | 自动执行 `synth_1`、`impl_1` 和 bitstream 流程，并核对实际运行状态 |\n| 时序分析 | 获取 WNS、TNS、WHS、THS 和关键路径 | 判断是否满足时序，定位 setup/hold 违例及跨时钟问题 |\n| 资源分析 | 查询 LUT、FF、BRAM、DSP、IO 使用率 | 判断设计是否放得下，分析资源热点和层次化占用 |\n| 消息诊断 | 获取 ERROR、CRITICAL WARNING、WARNING | 汇总综合和实现阶段的问题，辅助确定排查顺序 |\n| 设计查询 | 查询层次结构、端口、网络和单元 | 核对综合后的连接关系、模块实例和信号名称 |\n| Vivado 仿真 | 启动/重启/步进仿真、读取信号、设置断点 | 运行 xsim，查看 testbench、波形对象和指定信号值 |\n| Tcl 扩展 | 执行任意 Vivado Tcl 命令 | 调用尚未封装为专用 MCP 工具的 Vivado 能力 |\n| 大型报告 | 生成完整报告并按区段读取 | 避免超长报告一次性占满 AI 上下文窗口 |\n\n### 可以直接对 AI 这样说\n\n```text\n启动 Vivado，并检查当前会话是否健康。\n\n打开 D:\\FPGA\\my_project\\my_project.xpr，告诉我目标器件、顶层模块和当前运行状态。\n\n运行综合，使用 8 个并行任务。完成后汇总 ERROR、CRITICAL WARNING 和资源利用率。\n\n分析当前设计的时序，告诉我 WNS/TNS 是否满足，并列出最差的 10 条 setup 路径。\n\n只分析 clk_250m 时钟域中经过 u_tdc 的失败路径，并给出可能的优化方向。\n\n运行实现并生成 bitstream；每一步都确认 Vivado 的真实 STATUS 和 PROGRESS。\n\n启动行为级仿真，运行 1 us，然后读取 /tb/dut/data_out 和 /tb/dut/valid。\n\n执行 Tcl：report_drc -ruledecks default，并总结需要优先处理的问题。\n```\n\n---\n\n## 为什么使用这个项目\n\n| 常见问题 | Vivado MCP Native 的处理方式 |\n|---|---|\n| Windows 下传统 `pexpect` 方案难以直接运行 | 使用原生 `subprocess` 启动 `vivado.bat`、`vivado.cmd` 或 Linux `vivado` |\n| Vivado 启动慢 | 多次 MCP 调用复用同一个持久 Tcl 会话 |\n| Tcl 中包含引号、花括号、反斜杠或中文路径 | 使用 UTF-8 十六进制传输和唯一命令标记进行可靠分帧 |\n| 本地化 Vivado 提示符可能变化 | 不依赖 `Vivado%` 提示符解析命令边界 |\n| 长命令超时后容易留下 Vivado 子进程 | 超时后清理完整进程树，避免残留失步会话 |\n| 报告太长，AI 无法一次读完 | 支持完整报告落盘并按行或正则表达式分段读取 |\n| 不确定 Vivado 路径和编码是否正确 | 提供 `vivado-mcp-native-doctor` 一键诊断 |\n\n---\n\n## 环境要求\n\n| 组件 | 要求 |\n|---|---|\n| 操作系统 | Windows 10/11 或 Linux |\n| Python | 3.10–3.12 |\n| Vivado | 本机已经安装 AMD/Xilinx Vivado |\n| 许可证 | 覆盖计划使用的器件、IP 和设计流程 |\n| MCP 客户端 | 支持本地 `stdio` MCP Server |\n\n---\n\n## 安装\n\n### 方式一：使用 pip 安装\n\nWindows PowerShell：\n\n```powershell\npy -m pip install --upgrade vivado-mcp-native\n```\n\nLinux：\n\n```bash\npython3 -m pip install --upgrade vivado-mcp-native\n```\n\n检查安装结果：\n\n```powershell\npy -m pip show vivado-mcp-native\nvivado-mcp-native-doctor --help\n```\n\n### 方式二：使用 pipx 安装（推荐）\n\n`pipx` 会为 MCP Server 创建独立 Python 环境，减少与其他 Python 包的依赖冲突。\n\nWindows：\n\n```powershell\npy -m pip install --user --upgrade pipx\npy -m pipx ensurepath\npy -m pipx install vivado-mcp-native\n```\n\nLinux：\n\n```bash\npython3 -m pip install --user --upgrade pipx\npython3 -m pipx ensurepath\npython3 -m pipx install vivado-mcp-native\n```\n\n升级：\n\n```powershell\npy -m pipx upgrade vivado-mcp-native\n```\n\n### 方式三：直接从 GitHub 安装\n\n安装 `master` 分支最新源码：\n\n```powershell\npy -m pip install --upgrade \"git+https://github.com/Arthurzxy/vivado_mcp_native.git@master\"\n```\n\n使用 pipx：\n\n```powershell\npy -m pipx install --force \"git+https://github.com/Arthurzxy/vivado_mcp_native.git@master\"\n```\n\n不依赖本机 Git，也可以安装 GitHub ZIP：\n\n```powershell\npy -m pip install --upgrade \"https://github.com/Arthurzxy/vivado_mcp_native/archive/refs/heads/master.zip\"\n```\n\n用于开发或修改源码：\n\n```powershell\ngit clone https://github.com/Arthurzxy/vivado_mcp_native.git\ncd vivado_mcp_native\npy -m pip install -e .\n```\n\n### 安装后提供的命令\n\n| 命令 | 作用 |\n|---|---|\n| `vivado-mcp-native` | 启动 MCP stdio Server |\n| `vivado-mcp-native-doctor` | 检查 Python、Vivado、Tcl 和 Unicode 通信 |\n| `vivado-mcp-win` | 兼容旧配置的 Server 别名 |\n| `vivado-mcp-win-doctor` | 兼容旧配置的 Doctor 别名 |\n\n---\n\n## 快速开始\n\n### 第一步：确认 Vivado 启动文件\n\n`VIVADO_PATH` 可以指向：\n\n- 完整启动文件：`vivado.bat`、`vivado.cmd`、`vivado.exe` 或 Linux `vivado`；\n- Vivado 的 `bin` 目录；\n- Vivado 版本目录。\n\nWindows 示例：\n\n```powershell\n$env:VIVADO_PATH = \"D:\\Software\\Xilinx\\2025.2.1\\Vivado\\bin\\vivado.bat\"\n```\n\nLinux 示例：\n\n```bash\nexport VIVADO_PATH=\"/tools/Xilinx/Vivado/2025.2/bin/vivado\"\n```\n\n未显式配置时，Server 会检查系统 PATH 和常见安装目录。\n\n### 第二步：运行 Doctor\n\n```powershell\nvivado-mcp-native-doctor --vivado-path \"D:\\Software\\Xilinx\\2025.2.1\\Vivado\\bin\\vivado.bat\"\n```\n\n机器可读 JSON 输出：\n\n```powershell\nvivado-mcp-native-doctor --vivado-path \"D:\\Software\\Xilinx\\2025.2.1\" --json\n```\n\nDoctor 会依次检查：\n\n1. Vivado 启动文件解析；\n2. 持久 Tcl 会话启动；\n3. Vivado 和 Tcl 版本查询；\n4. Tcl 表达式执行；\n5. 中文 Unicode 往返；\n6. 会话健康状态；\n7. Vivado 正常关闭。\n\nDoctor 不会打开或修改用户工程。\n\n### 第三步：配置 MCP 客户端\n\n先查找安装后的命令路径：\n\n```powershell\n(Get-Command vivado-mcp-native).Source\n```\n\n#### 使用已安装的命令\n\n把下面的 `command` 和 `VIVADO_PATH` 替换为你的实际路径：\n\n```json\n{\n \"mcpServers\": {\n \"vivado\": {\n \"command\": \"C:\\\\Users\\\\you\\\\.local\\\\bin\\\\vivado-mcp-native.exe\",\n \"env\": {\n \"VIVADO_PATH\": \"D:\\\\Software\\\\Xilinx\\\\2025.2.1\\\\Vivado\\\\bin\\\\vivado.bat\"\n }\n }\n }\n}\n```\n\n#### 使用 Python 模块启动\n\n适用于虚拟环境或 `pip install` 后不方便定位命令的情况：\n\n```json\n{\n \"mcpServers\": {\n \"vivado\": {\n \"command\": \"C:\\\\Users\\\\you\\\\AppData\\\\Local\\\\Programs\\\\Python\\\\Python311\\\\python.exe\",\n \"args\": [\"-m\", \"vivado_mcp\"],\n \"env\": {\n \"VIVADO_PATH\": \"D:\\\\Software\\\\Xilinx\\\\2025.2.1\\\\Vivado\\\\bin\\\\vivado.bat\"\n }\n }\n }\n}\n```\n\n建议使用可执行文件的**绝对路径**，避免 MCP 客户端与终端使用不同 PATH。\n\n配置保存后，完全退出并重新启动 MCP 客户端，然后让 AI 执行：\n\n```text\n检查 Vivado MCP 的主机状态，启动会话并返回 Vivado 版本。\n```\n\n---\n\n## 推荐使用流程\n\n```text\n1. vivado-mcp-native-doctor 检查本机环境\n2. start_session 启动持久 Vivado Tcl 会话\n3. open_project 打开 .xpr 工程\n4. get_project_info 确认器件、工程和顶层信息\n5. run_synthesis 运行综合\n6. get_messages 查看错误和警告\n7. get_timing_summary 检查 WNS/TNS/WHS/THS\n8. get_utilization 检查 LUT/FF/BRAM/DSP/IO\n9. run_implementation 运行布局布线\n10. get_timing_paths 分析最差路径\n11. generate_bitstream 生成比特流\n12. stop_session 关闭 Vivado 并释放资源\n```\n\n综合和实现可能耗时较长。大型工程应在调用时增加 `timeout`，并根据 CPU 和内存情况设置合适的 `jobs`。\n\n---\n\n## MCP 工具说明\n\n### 会话管理\n\n- `start_session`：启动持久 Vivado Tcl 会话；\n- `stop_session`：正常关闭 Vivado；\n- `session_status`：查看命令数、错误数和会话统计；\n- `check_session_health`：检查会话响应并按需恢复；\n- `get_host_status`：查看主机名、可用内存和会话状态。\n\n### 工程与设计流程\n\n- `open_project` / `close_project`：打开或关闭 `.xpr` 工程；\n- `get_project_info`：获取当前工程信息；\n- `run_synthesis`：运行综合并验证 Vivado 的实际状态；\n- `run_implementation`：运行 place and route；\n- `generate_bitstream`：为已实现设计生成 bitstream。\n\n### 报告与设计查询\n\n- `get_timing_summary`：返回 WNS、TNS、WHS、THS 等结构化指标；\n- `get_timing_paths`：按时钟、起点、终点或 through 对象过滤关键路径；\n- `get_utilization`：返回 LUT、FF、BRAM、DSP 和 IO 使用率；\n- `get_clocks`：获取时钟与约束信息；\n- `get_messages`：分类读取 ERROR、CRITICAL WARNING 和 WARNING；\n- `get_design_hierarchy`：读取综合后设计层次；\n- `get_ports` / `get_nets` / `get_cells`：查询端口、网络和单元。\n\n### 仿真\n\n- `set_simulation_top`：设置 testbench 顶层；\n- `launch_simulation`：启动行为级或综合/实现后仿真；\n- `run_simulation` / `step_simulation` / `restart_simulation`：运行、步进或重启；\n- `get_signal_value` / `get_signal_values`：读取一个或一组信号；\n- `get_scopes` / `get_simulation_objects`：浏览仿真层次和对象；\n- `add_signals_to_wave`：添加波形信号；\n- `add_breakpoint` / `remove_breakpoints`：管理仿真断点；\n- `get_simulation_messages`：读取仿真日志；\n- `close_simulation`：关闭仿真。\n\n### 高级能力\n\n- `run_tcl`：执行任意 Vivado Tcl；\n- `generate_full_report`：生成 timing、utilization、power、DRC 等完整报告；\n- `read_report_section`：按行范围或正则表达式读取大型报告；\n- `request_feature` / `list_feature_requests`：记录当前未覆盖的功能需求。\n\n---\n\n## 工作原理\n\n```text\nClaude / Cursor / Cline / Cherry Studio / 其他 MCP 客户端\n │\n │ MCP stdio / JSON-RPC\n ▼\n Vivado MCP Native\n │\n │ 持久 subprocess Tcl 会话\n ▼\n AMD/Xilinx Vivado -mode tcl\n │\n ▼\n 本机 FPGA 工程与报告\n```\n\n每条 Tcl 命令会使用 UTF-8 十六进制编码并附加唯一标记。Server 分别提取标准输出、Tcl 返回值、返回码和错误栈，不依赖可能随语言环境变化的 `Vivado%` 提示符。\n\n---\n\n## 常见问题\n\n### 找不到 `vivado-mcp-native` 命令\n\n```powershell\npy -m pipx ensurepath\n(Get-Command vivado-mcp-native).Source\n```\n\n重启终端或把返回的绝对路径直接写入 MCP 客户端配置。\n\n### 找不到 Vivado\n\n先验证启动文件：\n\n```powershell\n& \"D:\\Software\\Xilinx\\2025.2.1\\Vivado\\bin\\vivado.bat\" -mode tcl\n```\n\n随后运行：\n\n```powershell\nvivado-mcp-native-doctor --vivado-path \"D:\\Software\\Xilinx\\2025.2.1\\Vivado\\bin\\vivado.bat\"\n```\n\n### 中文输出乱码\n\n```powershell\n$env:VIVADO_MCP_OUTPUT_ENCODING = \"gbk\"\n```\n\n可设置为 `utf-8`、`gbk`，或与本机 Vivado Tcl 控制台一致的编码。\n\n### 综合或实现超时\n\n超时后 Server 会终止完整 Vivado 进程树，防止继续使用已经失步的会话。重新启动会话，并为大型工程设置更长的 `timeout`。\n\n### `vivado-mcp` 和 `vivado-mcp-native` 是同一个包吗\n\n不是。安装本项目请始终使用：\n\n```powershell\npy -m pip install vivado-mcp-native\n```\n\n更多 Windows 配置说明参见 [`WINDOWS_INSTALL.md`](WINDOWS_INSTALL.md)。\n\n---\n\n## 安全说明\n\n`run_tcl` 可以按当前用户权限执行任意 Tcl，包括读写文件和启动外部程序。请注意：\n\n- 只连接可信的 MCP 客户端和模型；\n- 执行删除文件、重置工程或覆盖输出前检查目标路径；\n- 对重要工程使用版本控制并保留备份；\n- 不要把没有鉴权和隔离的 Vivado MCP 直接暴露到公网。\n\n---\n\n## 官方 MCP Registry\n\n官方 Registry 标识：\n\n```text\nio.github.Arthurzxy/vivado-mcp-native\n```\n\n注册元数据位于 [`server.json`](server.json)，当前发布版本为 `0.2.1`，传输方式为本地 `stdio`。\n\n---\n\n## 贡献\n\n欢迎通过 Issue 或 Pull Request：\n\n- 补充新的 Vivado 工具；\n- 改进不同 Vivado 版本的兼容性；\n- 增强报告解析；\n- 补充 MCP 客户端配置示例；\n- 修正文档或翻译。\n\n---\n\n## 许可证与致谢\n\n本项目使用 [MIT License](LICENSE)。\n\n- 原始项目由 Corey Hahn 创建；\n- 基于 [Model Context Protocol](https://modelcontextprotocol.io/)；\n- 集成 [AMD/Xilinx Vivado](https://www.amd.com/en/products/software/adaptive-socs-and-fpgas/vivado.html)。\n", "bytes": 10310, "sha": "75670ad5e8dc626c0c7521aad696aa85434e909d846eda1a48c279f1ec03b21d", "repo_slug": "arthurzxy/vivado_mcp_native", "fonte": "repo", "truncated": false, "api": "https://agentalog.com/api/listings/mcp_io_github_arthurzxy_vivado_mcp_native_36353774/readme" }