Skip to main content

MCP Server for AI-powered RTL diagram generation

Project description

RTLViz - AI-Powered RTL Diagram Generator

An MCP (Model Context Protocol) server that enables AI assistants to generate publication-quality RTL block diagrams from Verilog/SystemVerilog code.

Installation

pip install rtlviz
rtlviz-setup

That's it! The setup command auto-configures your AI IDE (Claude Desktop or VS Code).

Manual Setup (Alternative)

If auto-setup doesn't work, you can configure manually:

Claude Desktop (claude_desktop_config.json):

{
  "mcpServers": {
    "rtlviz": {
      "command": "rtlviz-server"
    }
  }
}

VS Code (.vscode/mcp.json):

{
  "servers": {
    "rtlviz": {
      "command": "rtlviz-server"
    }
  }
}

Usage

Just ask your AI: "Generate an RTL diagram for CPU.v"

How It Works

  1. You install the package (pip install rtlviz)
  2. Your IDE spawns the server locally when you open a session
  3. The AI reads the rtlviz://prompt resource to learn how to analyze RTL
  4. The AI generates Graphviz DOT code based on your Verilog
  5. The AI calls the render_diagram tool to create an interactive HTML viewer

No server hosting required. No API keys. Runs 100% locally.

Enterprise & Privacy

  • Safe for Work: All RTL analysis happens locally or via your enterprise-approved LLM provider.
  • Telemetry: We collect minimal, anonymous usage data (version, session ID) to improve the tool.
    • No IP addresses or personal data.
    • No file contents or code.
  • Opt-Out: Set the environment variable RTLVIZ_TELEMETRY=0 to disable all network calls.
    • Firewall Friendly: If blocked, the tool fails silently and continues working.

Developing & Releasing

Analytics Setup

To enable your own analytics dashboard:

  1. Deploy analytics/google_apps_script.js as a Google Web App (Execute as Me, Access: Anyone).
  2. Set RTLVIZ_TELEMETRY_URL in src/rtlviz/telemetry.py to your Web App URL.

Publishing to PyPI

  1. Bump Version: Update pyproject.toml and src/rtlviz/telemetry.py.
  2. Build: python -m build
  3. Upload: twine upload dist/*

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rtlviz-0.2.0.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rtlviz-0.2.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file rtlviz-0.2.0.tar.gz.

File metadata

  • Download URL: rtlviz-0.2.0.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for rtlviz-0.2.0.tar.gz
Algorithm Hash digest
SHA256 828588ad87c3bd64bd03d00e27bd12ffa302431f034b958be883e26a8e64b834
MD5 784d5854d3b75367425cdecb4a4b2c26
BLAKE2b-256 9b09261eac0335a8c52f0f4cff09e940a02828e05d50f209bd222cd1a599e582

See more details on using hashes here.

File details

Details for the file rtlviz-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: rtlviz-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for rtlviz-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2eff3c5d7c896e0a84984c0eedab68fb2eb0cb7ce48212c0ed13906faefa387
MD5 22f718641bf2b3d5149e024db45e77ca
BLAKE2b-256 5defc9582253d64964a5d670bca2b2ee7f7e6941eaf8dac4c94cf8ab22e0ca3d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page