Metadata-Version: 2.4
Name: openroad-mcp
Version: 0.6.1
Summary: The OpenROAD MCP server
Author-email: Precision Innovations <it-support@precisioninno.com>
Requires-Python: >=3.13
Requires-Dist: fastmcp==3.2.0
Requires-Dist: mcp[cli]==1.28.1
Requires-Dist: pillow==12.3.0
Requires-Dist: psutil==7.2.2
Requires-Dist: pydantic==2.12.5
Provides-Extra: dev
Requires-Dist: google-genai==1.69.0; extra == 'dev'
Requires-Dist: mypy==1.20.0; extra == 'dev'
Requires-Dist: pre-commit==4.5.1; extra == 'dev'
Requires-Dist: pytest-asyncio==1.3.0; extra == 'dev'
Requires-Dist: pytest-cov==7.1.0; extra == 'dev'
Requires-Dist: pytest==9.0.3; extra == 'dev'
Requires-Dist: ruff==0.15.8; extra == 'dev'
Requires-Dist: types-psutil==7.2.2.20260130; extra == 'dev'
Description-Content-Type: text/markdown

# 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](https://github.com/The-OpenROAD-Project/openroad-mcp/blob/main/README.md)
> 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](../README.md) and the
[Quick Start guide](../QUICKSTART.md).

## Requirements

- **OpenROAD** installed and available in your PATH
  ([installation guide](https://openroad.readthedocs.io/en/latest/main/GettingStarted.html))
- **OpenROAD-flow-scripts (ORFS)** for complete RTL-to-GDS flows (optional but recommended)
- **Python 3.13+** and the [`uv`](https://astral.sh/uv) package manager
  - Install uv: `curl -LsSf https://astral.sh/uv/install.sh | sh`

## Configuration (uvx) — deprecated

```json
{
  "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:

```bash
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](../CONTRIBUTING.md) for the full workflow.
