io.github.luarss/openroad-mcp

Official

by The-OpenROAD-Project · Python

The OpenROAD MCP server - interactive EDA sessions via Model Context Protocol

Interactive EDA design sessions via Model Context Protocol.

Topics

ai-toolsasic-designchip-designedafastmcpmcpmodel-context-protocolopenroadphysical-designpythonvlsi

README.md18 KBView on GitHub

OpenROAD MCP Server

A Model Context Protocol (MCP) server that provides tools for interacting with OpenROAD and ORFS (OpenROAD Flow Scripts).

Demo

OpenROAD MCP Demo

Watch full demo video

Features

Interactive OpenROAD sessions - Execute commands in persistent OpenROAD sessions with PTY support
Session management - Create, list, inspect, and terminate multiple sessions
Command history - Access full command history for any session
Performance metrics - Get comprehensive metrics across all sessions
Report visualization - List and read report images from ORFS runs

Requirements

OpenROAD installed and available in your PATH
- Installation guide
OpenROAD-flow-scripts (ORFS) for complete RTL-to-GDS flows (optional but recommended)
- ORFS installation guide
Python 3.13+ or higher
uv package manager
- Install: curl -LsSf https://astral.sh/uv/install.sh | sh

Support Matrix

MCP Client	Supported	Transport Mode(s)	Config file
Claude Code	✅	STDIO	`.claude/settings.json`
Claude Desktop	✅	STDIO	`~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
Cursor	✅	STDIO	`.cursor/mcp.json`
GitHub Copilot (VS Code)	✅	STDIO	`.vscode/mcp.json`
Gemini CLI	✅	STDIO	`~/.gemini/settings.json`
Windsurf	✅	STDIO	`~/.codeium/windsurf/mcp_config.json`
Cline	✅	STDIO	VS Code globalStorage (see below)
Roo Code	✅	STDIO	`.roo/mcp.json`
Continue	✅	STDIO	`~/.continue/config.json`
Zed	✅	STDIO	`~/.config/zed/settings.json`
JetBrains AI Assistant	✅	STDIO	Settings UI
Amazon Q Developer CLI	✅	STDIO	`~/.aws/amazonq/mcp.json`
Augment Code	✅	STDIO	VS Code `settings.json`
Warp	✅	STDIO	Settings UI
Amp	✅	STDIO	CLI-managed
Trae	✅	STDIO	User config
Opencode	✅	STDIO	`opencode.json`
Kiro	✅	STDIO	Settings UI
Kilo Code	✅	STDIO	`.kilocode/mcp.json`
Goose	✅	STDIO	`~/.config/goose/config.yaml`
Sourcegraph Cody	✅	STDIO	VS Code `settings.json`
OpenAI Codex CLI	✅	STDIO	`~/.codex/config.toml`
PearAI	✅	STDIO	`~/pearai/config.json`
CodeBuddy	✅	STDIO	`~/.codebuddy/config.jsonc`
Hermes Agent	✅	STDIO	`~/.hermes/config.yaml`
GitHub Copilot CLI	✅	STDIO	`~/.copilot/mcp-config.json`
Oh My Pi	✅	STDIO	`.omp/mcp.json`
OpenClaw	✅	STDIO	`~/.openclaw/openclaw.json`
AstrBot	✅	STDIO	WebUI
DeepCode	✅	STDIO	`deepcode_config.json`
nanobot	✅	STDIO	`nanobot.yaml`
Crush	✅	STDIO	`.crush.json`
Reasonix	✅	STDIO	`reasonix.toml`
Other MCP clients	⚠️	STDIO	Should work with standard STDIO transport

Getting Started

New to OpenROAD MCP? Check out our Quick Start guide.

For platform-specific setup instructions, see the Cross-Platform Guide.

Standard Configuration

The basic configuration for all MCP clients:

json

{
  "mcpServers": {
    "openroad-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
        "openroad-mcp"
      ]
    }
  }
}

Note: The URL above is pinned to a specific release for supply chain safety. To always track the latest version instead, drop the @v0.5.5 suffix: "git+https://github.com/The-OpenROAD-Project/openroad-mcp".

For local development, use:

json

{
  "mcpServers": {
    "openroad-mcp": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/openroad-mcp",
        "run",
        "openroad-mcp"
      ]
    }
  }
}

Installation

<details> <summary>Claude Code</summary>

bash

claude mcp add --transport stdio openroad-mcp -- uvx --from git+https://github.com/The-OpenROAD-Project/openroad-mcp openroad-mcp

Or add the standard configuration to .claude/settings.json.

</details> <details> <summary>Claude Desktop</summary>

Add the standard configuration to:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json

</details> <details> <summary>Cursor</summary>

Add the standard configuration to .cursor/mcp.json.

</details> <details> <summary>GitHub Copilot (VS Code)</summary>

Add to .vscode/mcp.json (VS Code 1.99+). Note the different schema — servers key and "type": "stdio" required:

json

{
  "servers": {
    "openroad-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
        "openroad-mcp"
      ]
    }
  }
}

</details> <details> <summary>Gemini CLI</summary>

Follow the Gemini MCP install guide, using the standard configuration above.

</details> <details> <summary>Windsurf</summary>

Add the standard configuration to ~/.codeium/windsurf/mcp_config.json.

</details> <details> <summary>Cline</summary>

Add to the Cline MCP settings file:

macOS: ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
Windows: %APPDATA%\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json
Linux: ~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

json

{
  "mcpServers": {
    "openroad-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
        "openroad-mcp"
      ],
      "disabled": false,
      "autoApprove": []
    }
  }
}

</details> <details> <summary>Roo Code</summary>

Add to .roo/mcp.json in your project root (or the equivalent user-level settings file via the Roo Code UI):

json

{
  "mcpServers": {
    "openroad-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
        "openroad-mcp"
      ],
      "disabled": false,
      "autoApprove": []
    }
  }
}

</details> <details> <summary>Continue</summary>

Add to ~/.continue/config.json:

json

{
  "experimental": {
    "modelContextProtocolServers": [
      {
        "transport": {
          "type": "stdio",
          "command": "uvx",
          "args": [
            "--from",
            "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
            "openroad-mcp"
          ]
        }
      }
    ]
  }
}

</details> <details> <summary>Zed</summary>

Add to ~/.config/zed/settings.json:

json

{
  "context_servers": {
    "openroad-mcp": {
      "command": {
        "path": "uvx",
        "args": [
          "--from",
          "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
          "openroad-mcp"
        ]
      },
      "settings": {}
    }
  }
}

</details> <details> <summary>JetBrains AI Assistant</summary>

Open Settings → Tools → AI Assistant → Model Context Protocol (MCP) and add a new server entry using the standard configuration.

</details> <details> <summary>Amazon Q Developer CLI</summary>

Add the standard configuration to ~/.aws/amazonq/mcp.json.

</details> <details> <summary>Augment Code</summary>

Add to your VS Code settings.json (User or Workspace scope):

json

{
  "augment.advanced": {
    "mcpServers": [
      {
        "name": "openroad-mcp",
        "command": "uvx",
        "args": [
          "--from",
          "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
          "openroad-mcp"
        ]
      }
    ]
  }
}

</details> <details> <summary>Warp</summary>

Open Settings → AI → MCP Servers → Add New MCP Server and enter:

Name: openroad-mcp
Command: uvx
Args: --from git+https://github.com/The-OpenROAD-Project/openroad-mcp openroad-mcp

</details> <details> <summary>Amp</summary>

bash

amp mcp add openroad-mcp uvx --from git+https://github.com/The-OpenROAD-Project/openroad-mcp openroad-mcp

</details> <details> <summary>Trae</summary>

Add the standard configuration to the MCP section of Trae's user settings (accessible via Settings → MCP).

</details> <details> <summary>Opencode</summary>

Add to opencode.json in your project root:

json

{
  "mcp": {
    "openroad-mcp": {
      "type": "local",
      "command": [
        "uvx",
        "--from",
        "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
        "openroad-mcp"
      ],
      "enabled": true
    }
  }
}

</details> <details> <summary>Kiro</summary>

Open the MCP configuration panel in Kiro and add a new server entry using the standard configuration.

</details> <details> <summary>Kilo Code</summary>

Add to .kilocode/mcp.json in your project root:

json

{
  "mcpServers": {
    "openroad-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
        "openroad-mcp"
      ],
      "alwaysAllow": [],
      "disabled": false
    }
  }
}

</details> <details> <summary>Goose</summary>

Add to ~/.config/goose/config.yaml:

yaml

extensions:
  openroad-mcp:
    name: openroad-mcp
    type: stdio
    cmd: uvx
    args:
      - --from
      - git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5
      - openroad-mcp
    enabled: true

</details> <details> <summary>Sourcegraph Cody</summary>

Add to your VS Code settings.json:

json

{
  "openctx.providers": {
    "https://openctx.org/npm/@openctx/provider-mcp": {
      "transports": [
        {
          "type": "stdio",
          "command": "uvx",
          "args": [
            "--from",
            "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
            "openroad-mcp"
          ]
        }
      ]
    }
  }
}

</details> <details> <summary>OpenAI Codex CLI</summary>

Add to ~/.codex/config.toml (global) or .codex/config.toml (project-scoped):

toml

[[mcp_servers]]
name = "openroad-mcp"
command = "uvx"
args = ["--from", "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5", "openroad-mcp"]

</details> <details> <summary>PearAI</summary>

PearAI uses the same config format as Continue. Add to ~/pearai/config.json:

json

{
  "experimental": {
    "modelContextProtocolServers": [
      {
        "transport": {
          "type": "stdio",
          "command": "uvx",
          "args": [
            "--from",
            "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
            "openroad-mcp"
          ]
        }
      }
    ]
  }
}

</details> <details> <summary>CodeBuddy</summary>

Add to ~/.codebuddy/config.jsonc (global) or .codebuddy/mcp.jsonc (project-scoped):

jsonc

{
  "mcpServers": {
    "openroad-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
        "openroad-mcp"
      ]
    }
  }
}

</details> <details> <summary>Hermes Agent</summary>

Add to ~/.hermes/config.yaml:

yaml

mcp_servers:
  - name: openroad-mcp
    transport: stdio
    command: uvx
    args:
      - --from
      - git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5
      - openroad-mcp

</details> <details> <summary>GitHub Copilot CLI</summary>

Add to ~/.copilot/mcp-config.json:

json

{
  "mcpServers": {
    "openroad-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
        "openroad-mcp"
      ]
    }
  }
}

Or run /mcp add inside a Copilot CLI session for guided setup.

</details> <details> <summary>Oh My Pi</summary>

Add to .omp/mcp.json (project-level) or ~/.omp/agent/mcp.json (global):

json

{
  "mcpServers": {
    "openroad-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
        "openroad-mcp"
      ]
    }
  }
}

</details> <details> <summary>OpenClaw</summary>

Add to ~/.openclaw/openclaw.json:

json

{
  "mcp": {
    "servers": {
      "openroad-mcp": {
        "command": "uvx",
        "args": [
          "--from",
          "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
          "openroad-mcp"
        ],
        "enabled": true
      }
    }
  }
}

Or run openclaw mcp add for guided setup.

</details> <details> <summary>AstrBot</summary>

Navigate to the AstrBot WebUI → MCP section → Add Server, and enter:

json

{
  "command": "uvx",
  "args": ["--from", "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5", "openroad-mcp"]
}

Requires uv installed on the host running AstrBot.

</details> <details> <summary>DeepCode</summary>

Add to deepcode_config.json in your project root:

json

{
  "tools": {
    "mcpServers": {
      "openroad-mcp": {
        "type": "stdio",
        "command": "uvx",
        "args": [
          "--from",
          "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
          "openroad-mcp"
        ]
      }
    }
  }
}

</details> <details> <summary>nanobot</summary>

Add to nanobot.yaml in your project root:

yaml

mcpServers:
  openroad-mcp:
    command: uvx
    args:
      - --from
      - git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5
      - openroad-mcp

</details> <details> <summary>Crush</summary>

Add to .crush.json (project-local) or ~/.config/crush/crush.json (global):

json

{
  "mcp": {
    "openroad-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5",
        "openroad-mcp"
      ]
    }
  }
}

</details> <details> <summary>Reasonix</summary>

Add to reasonix.toml (project root) or ~/.config/reasonix/config.toml (global):

toml

[[plugins]]
name    = "openroad-mcp"
command = "uvx"
args    = ["--from", "git+https://github.com/The-OpenROAD-Project/openroad-mcp@v0.5.5", "openroad-mcp"]

Alternatively, use the standard .mcp.json format — Reasonix auto-discovers it.

</details> <details> <summary>Docker</summary>

🚧 Work in Progress: Docker deployment via GitHub Container Registry (GHCR) is coming soon.

</details> <details> <summary>MCP Registry</summary>

Once published to the MCP Registry, clients can discover and install directly:

bash

uvx openroad-mcp

</details>

Verification

After configuration, restart your MCP client and verify the MCP server is running:

The server should automatically start when your MCP client launches
You can use OpenROAD tools through the MCP interface
Check logs for any startup errors if tools are not available

Available Tools

Once configured, the following tools are available:

interactive_openroad - Execute commands in an interactive OpenROAD session
create_interactive_session - Create a new OpenROAD session
list_interactive_sessions - List all active sessions
terminate_interactive_session - Terminate a session
inspect_interactive_session - Get detailed session information
get_session_history - View command history
get_session_metrics - Get performance metrics
list_report_images - List ORFS report directory images
read_report_image - Read a ORFS report image

Troubleshooting

If the MCP server fails to start:

Ensure uv is installed and available in your PATH
Verify the path to openroad-mcp is correct
Check that all dependencies are installed: make sync
Review your MCP client logs for specific error messages

Development

Setup

bash

# Install environment
uv venv
make sync

Testing

bash

# Run core tests (recommended - excludes PTY tests that may fail in some environments)
make test

# Run interactive PTY tests separately (may have file descriptor issues in CI)
make test-interactive

# Run all tests including potentially problematic PTY tests
make test-all

# Format and check code
make format
make check

Note: Interactive PTY tests are separated because they may experience file descriptor issues in certain environments (containers, CI systems). The core functionality tests (make test) provide comprehensive coverage of the MCP integration without these environment-specific issues.

MCP Inspector

bash

# Launch MCP inspector for debugging
# For STDIO transport: Set Command as "uv", Arguments as "run openroad-mcp"
make inspect

Contributing

We welcome contributions to OpenROAD MCP! Please see CONTRIBUTING.md for detailed instructions on how to get started, our development workflow, and code standards.

Support

If you encounter any issues or have questions, please open an issue on our GitHub issue tracker.

License

BSD 3-Clause License. See LICENSE file.

Built with ❤️ by Precision Innovations

Install

claude_desktop_config.json

{
  "mcpServers": {
    "openroad-mcp": {
      "command": "uvx",
      "args": [
        "openroad-mcp"
      ]
    }
  }
}