openroad-mcp
The OpenROAD MCP server enables interaction with OpenROAD and OpenROAD Flow Scripts (ORFS) for chip design workflows. Here's what you can do:
Execute read-only commands — Run query/report commands like
report_*,get_*,check_*, timing analysis, and help lookups without modifying design state.Execute state-modifying commands — Run commands that change design state, such as loading designs, running placement/routing, applying constraints, and writing output files.
Session Management — Create persistent sessions (with optional custom working directories and environment variables), list active sessions, inspect session metadata/status, and terminate sessions gracefully or forcefully.
Command History — Access full or filtered command history for any session.
Performance Metrics — Retrieve comprehensive metrics across all active sessions.
ORFS Report Images — List available report images from ORFS runs (organized by platform, design, and stage) and retrieve specific images as base64-encoded data with metadata for visualization.
Allows Amazon Q Developer CLI to leverage OpenROAD for chip design tasks.
Provides OpenROAD tools within the Amp MCP client for chip design automation.
Provides OpenROAD tools within GitHub Copilot for chip design workflow, including session management and command execution.
Integrates OpenROAD chip design capabilities into Hermes Agent for automated design workflows.
Integrates OpenROAD chip design capabilities into JetBrains AI Assistant, allowing session management and command execution.
Allows OpenAI Codex CLI to interact with OpenROAD for chip design, including running commands and viewing reports.
Enables Warp AI to execute OpenROAD commands and manage sessions for chip design automation.
OpenROAD MCP Server
A Model Context Protocol (MCP) server that provides tools for interacting with OpenROAD and ORFS.
About OpenROAD MCP
New here? Check out the Quick Start Guide to get your AI assistant analyzing designs in 5 minutes.
OpenROAD MCP eliminates the barrier between your AI assistant and physical design by connecting Claude, Cursor, and other MCP-compatible clients directly to the OpenROAD layout tools.
OpenROAD is the leading open-source, foundational application for semiconductor digital design, delivering an Autonomous, No-Human-In-Loop (NHIL) flow from RTL-GDSII. OpenROAD-flow-scripts (ORFS) is the fully autonomous flow built around it.
With this MCP server, your AI assistant can:
Execute Commands - Run interactive OpenROAD sessions with full PTY support.
Manage Sessions - Create, list, inspect, and terminate multiple physical design sessions.
Track History & Metrics - Access full command history and performance metrics for analysis.
Visualize Reports - List and read report images from ORFS runs directly in the chat.
Related MCP server: MCP Server
Demo

Requirements & Installation
To use this MCP server, you need the server runtime, plus the underlying OpenROAD layout tools.
1. Server Runtime
Node.js 22+ is required to run the
npxdistribution.
2. OpenROAD
OpenROAD must be installed and available in your PATH.
3. OpenROAD-flow-scripts (ORFS)
ORFS is optional but highly recommended for complete RTL-to-GDS flows and report visualization.
Configuration
For platform-specific Node.js and C++ toolchain setup instructions, see the Cross-Platform Build Guide.
You do not need to clone this repo or pass path environment variables in the common case. The published npx package does not read a .env file.
On startup the server inherits the MCP client's environment, then fills PATH the same way which openroad would: current PATH, then your login-shell PATH, then common install locations (/opt/homebrew/bin, conda, local OpenROAD builds). ORFS_FLOW_PATH defaults to ~/OpenROAD-flow-scripts/flow, and is also detected when ORFS sits next to the openroad binary.
Supported MCP Clients
Here is the standard base configuration used across most clients:
{
"command": "npx",
"args": ["-y", "openroad-mcp"]
}Find your specific client below for the exact configuration snippet and file location.
claude mcp add --transport stdio openroad-mcp -- npx -y openroad-mcpOr add the standard config to .mcp.json / .claude/settings.json.
If a GUI-launched client still cannot find openroad, pass an override. Use command -v so you do not hard-code paths:
claude mcp add \
--env PATH="$(dirname "$(command -v openroad)"):${PATH}" \
--env ORFS_FLOW_PATH="${HOME}/OpenROAD-flow-scripts/flow" \
--transport stdio openroad-mcp \
-- npx -y openroad-mcpPut --transport between --env and the server name so the CLI does not treat the name as another KEY=value pair.
Add the standard config to:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%\Claude\claude_desktop_config.json
Add the standard config to .cursor/mcp.json.
Add to .vscode/mcp.json. Requires "type": "stdio":
{
"servers": {
"openroad-mcp": {
"type": "stdio",
"command": "npx",
"args": ["-y", "openroad-mcp"]
}
}
}Add the standard config to ~/.codeium/windsurf/mcp_config.json.
Add the standard config to cline_mcp_settings.json (Cline) or .roo/mcp.json (Roo Code).
Add to your respective config.json under modelContextProtocolServers:
{
"transport": {
"type": "stdio",
"command": "npx",
"args": ["-y", "openroad-mcp"]
}
}Add to ~/.config/zed/settings.json:
{
"context_servers": {
"openroad-mcp": {
"command": {
"path": "npx",
"args": ["-y", "openroad-mcp"]
}
}
}
}The server is available on the MCP Registry and via Docker:
docker run --rm -i ghcr.io/the-openroad-project/openroad-mcp:latestMost other standard STDIO clients are fully supported. Refer to your tool's MCP setup guide.
Available Tools
Once configured, your AI assistant will have access to the following tools. For detailed parameters, schemas, and return formats, see the API Reference.
interactive_openroad_queryinteractive_openroad_execcreate_interactive_sessionlist_interactive_sessionsterminate_interactive_sessioninspect_interactive_sessionget_session_historyget_session_metricslist_report_imagesread_report_image
Troubleshooting
The server fails to start: Ensure you have Node.js 22+. Older versions will fail.
Session creation fails: Confirm
command -v openroadworks in a terminal. The server inherits PATH and searches common install locations; if your prefix is unusual, passPATHwith--envas shown in the Claude Code section.Commands rejected with CommandBlocked: You sent a state-modifying command to
interactive_openroad_query. Useinteractive_openroad_execinstead.Report images not found: The server defaults to
~/OpenROAD-flow-scripts/flow. If ORFS lives elsewhere, setORFS_FLOW_PATHin the MCP client'senvblock (not a.envfile).
To get more detail, set LOG_LEVEL=DEBUG in the server's environment.
Development
Clone the repository. .env.example is a local-dev reference only; copy it to .env if you use direnv or similar. The server still reads process.env (the MCP client's env block), not the file.
Then run:
cd typescript
npm install
npm run buildTesting:
npm run test # unit tests
npm run test:integration # integration tests
npm run test:performance # performance benchmarksLinting & type checking:
npm run typecheck
npm run lintContributing
We welcome contributions! Please see CONTRIBUTING.md for detailed instructions on our development workflow and code standards.
License
BSD 3-Clause License. See LICENSE file.
Built with ❤️ by Precision Innovations
Available Tools
10 toolscreate_interactive_sessionC
Create a new interactive OpenROAD session.
Inputs: session_id, command, env, cwd. Returns: result
get_session_historyCRead-onlyIdempotent
Get command history for an interactive OpenROAD session.
Inputs: session_id (required), limit, search. Returns: result
get_session_metricsBRead-onlyIdempotent
Get comprehensive metrics for all interactive OpenROAD sessions.
Inputs: no named parameters. Returns: result
inspect_interactive_sessionARead-onlyIdempotent
Get detailed inspection data for an interactive OpenROAD session.
Inputs: session_id (required). Returns: result
interactive_openroad_execADestructive
Execute a state-modifying OpenROAD command (set_*, create_*, read_*, write_*, flow commands).
Use this for loading designs, running placement/routing, applying constraints, and writing output files. Read-only commands are blocked — use interactive_openroad_query instead.
Inputs: command (required), session_id, timeout_ms. Returns: result
interactive_openroad_queryARead-only
Execute a read-only OpenROAD command (report_*, get_*, check_*, sta, help, etc.).
Use this for querying design state, generating reports, and inspecting timing. Commands that modify design state are blocked — use interactive_openroad_exec instead.
Inputs: command (required), session_id, timeout_ms. Returns: result
list_interactive_sessionsARead-onlyIdempotent
List all active interactive OpenROAD sessions.
Inputs: no named parameters. Returns: result
list_report_imagesBRead-onlyIdempotent
List available report images from ORFS runs organized by stage.
Inputs: platform (required), design (required), run_slug (required), stage. Returns: result
read_report_imageCRead-onlyIdempotent
Read a report image and return base64-encoded data with metadata.
Inputs: platform (required), design (required), run_slug (required), image_name (required). Returns: result
terminate_interactive_sessionADestructiveIdempotent
Terminate an interactive OpenROAD session.
Inputs: session_id (required), force. Returns: result
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 10 tools
The query/exec split is clearly disambiguated by read-only vs state-modifying behavior with explicit cross-references. Session management, command execution, and report image tools each have distinct targets, though inspect_interactive_session and get_session_metrics have slight semantic overlap.
Most tools follow a clear verb_noun pattern: list/create/terminate/inspect/get/read. However, interactive_openroad_query and interactive_openroad_exec put the verb at the end and do not match the otherwise consistent session/report naming pattern.
Ten tools is well-scoped for the server's purpose: command execution, session lifecycle, session introspection, and report image access. Each tool has a clear role and no redundant additions inflate the count.
The tool surface covers session creation/listing/termination, read/write command execution, history/metrics, and report image retrieval. Minor gaps exist, such as no explicit session attach or live output streaming, but the core workflows are fully usable without dead ends.
Maintenance
Related MCP Connectors
Ovanek MCP: Model Context Protocol server for Ovanek platform tools; writes are dry-run by default.
MCP server for progressive tool usage at any scale (see https://klavis.ai)
A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with yo…
One MCP server for all your MCP servers: code mode, per-tool permissions, approvals and audit.
Related MCP Servers
- AlicenseBqualityNot gradedmaintenanceA Model Context Protocol (MCP) server that provides JSON-RPC functionality through OpenRPC.242Apache 2.0
- AlicenseNot gradedqualityDmaintenanceMCP Server simplifies the implementation of the Model Context Protocol by providing a user-friendly API to create custom tools and manage server workflows efficiently.39 npm4MIT
- FlicenseNot gradedqualityDmaintenanceA server implementation of the Model Context Protocol (MCP) that provides REST API endpoints for managing and interacting with MCP resources.-
- FlicenseNot gradedqualityDmaintenanceA Model Context Protocol (MCP) server that exposes KiCad PCB design automation tools to AI assistants and other MCP clients.-