MCP for Vivado

An AI-oriented Vivado MCP workbench.
This project adopts an MCP-first design and does not provide a self-developed desktop GUI; Vivado-related operations must be performed in the actual Vivado GUI, switching to the corresponding visual context at critical steps.

Current Status

• Version: v2.0.0

• PM Conclusion: v2 overall completion

• Current release scope:

  • Windows mainline usage scenarios

  • v2 public workflow methodology

  • phase-2 core cross-domain closed-loop

  • phase-3 proof / contract / semantic / referent / public schema closing chain

Related MCP server: Vivado MCP Server

Applicable Scenarios

• AI-driven MCP / workflow methods to manage the main Vivado design, verification, and debugging processes

• Automatic discovery of local Vivado versions and workspace-level binding

• Designing IP, designing Block Design, and running simulations

• Automatic feedback and re-verification across simulation / timing / ILA / design follow-up

• Displaying context corresponding to key steps in the Vivado GUI

Directory Description

• docs/USER_INSTALL_AND_USAGE.md User installation and usage instructions

• docs/AI_INSTALL_AND_USAGE.md Access instructions for AI / Agents

• docs/AI_MCP_RELEASE_INSTALL.md Release installation instructions for AI / MCP clients

• scripts/install_mcp_for_ai.ps1 Windows one-click installation script

• docs/mcp/V2_PUBLIC_API.md v2 public MCP method list

• docs/pm/V2_FINAL_COMPLETION_MEMO.md v2 final completion memo

• docs/V2_RELEASE_PACKAGE.md v2 release package description and manifest

Quick Start

1. Install Python 3.11+

2. Install Vivado and ensure the version is no lower than 2018.3

3. Execute:

cd D:\ai_playgraund\vivado_mcp
powershell -ExecutionPolicy Bypass -File .\scripts\install_mcp_for_ai.ps1

4. Follow docs/USER_INSTALL_AND_USAGE.md or docs/AI_INSTALL_AND_USAGE.md to start using

Current Entry Points

The current release exposes Python in-process MCP-style entry points:

• server.py

• v2_public_server.py

Core classes:

• fpga_mcp.FpgaMcpServer

• fpga_mcp.FpgaMcpV2PublicServer

Notes:

• This repository provides a Python package entry point for "method registration + protocol return shell + orchestration wiring"

• It is not an independent stdio / HTTP transport layer service

• To connect to an external AI host, you can directly import FpgaMcpV2PublicServer in the host and call list_methods() / invoke()

v2 Public Methods

• create_workflow

• get_workflow

• list_workflows

• design_block_design

• design_ip

• run_simulation

• confirm_workflow

• reject_workflow

• cancel_workflow

• submit_workflow_input

• get_workflow_events