openroad-mcp

OpenROAD MCP Server (Python distribution)

Deprecated. This Python/PyPI distribution is no longer maintained and this is its final release. Please switch to the npm distribution: npx -y openroad-mcp. See the main project README for setup instructions.

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

This is the Python distribution, published to PyPI and runnable with uvx. It is one of two interchangeable distributions of openroad-mcp — the other is the Node.js distribution published to npm and runnable with npx. Both expose identical tools and behavior; pick the one that matches your installed runtime.

For the full feature list, client support matrix, configuration examples, and architecture docs, see the main project README and the Quick Start guide.

Requirements

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

Configuration (uvx) — deprecated

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

The pinned @v0.5.5 suffix is recommended for supply-chain safety; drop it to track the latest release.

Local development

This package lives under python/ in the repository. From the repo root:

cd python
uv sync --all-extras --inexact
uv run openroad-mcp --help

Common tasks are wired through the root Makefile (make check, make test, make test-tools, ...). See CONTRIBUTING.md for the full workflow.