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.2.tar.gz (10.2 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.2-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rtlviz-0.2.2.tar.gz
  • Upload date:
  • Size: 10.2 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.2.tar.gz
Algorithm Hash digest
SHA256 220787cb73d772d6dba59d116de31326e2f9fff1fdff0e8a027d29a57f21a988
MD5 e6077300dcc13303455c6423cb42d37f
BLAKE2b-256 23044476be6a2643a8ec9ae85b00fa980aa6b7fb55294aac8675e82299de2b83

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rtlviz-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 12.5 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2bf2208ad2f7e674274e5aed39e1bb0756ff123a9589ed4918a2134d32c1567a
MD5 9dd4b6b6e864e564dd450c9551b4f69b
BLAKE2b-256 8e7bd8d8a0610c24599cd9aa006964ce3964106a5c2799153529b626c893af90

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