{"id":29744145,"url":"https://github.com/luarss/openroad-mcp","last_synced_at":"2026-04-01T16:40:48.922Z","repository":{"id":305375683,"uuid":"1022718791","full_name":"luarss/openroad-mcp","owner":"luarss","description":"  Model Context Protocol (MCP) server for OpenROAD","archived":false,"fork":false,"pushed_at":"2026-01-25T00:13:41.000Z","size":6478,"stargazers_count":1,"open_issues_count":10,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-25T13:44:07.367Z","etag":null,"topics":["ai-tools","asic-design","chip-design","eda","fastmcp","mcp","model-context-protocol","openroad","physical-design","python","vlsi"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luarss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-19T17:14:55.000Z","updated_at":"2026-01-17T21:32:38.000Z","dependencies_parsed_at":"2025-08-17T21:09:56.082Z","dependency_job_id":"b4e9e128-52cc-47f7-92b5-d160b7151809","html_url":"https://github.com/luarss/openroad-mcp","commit_stats":null,"previous_names":["luarss/openroad-mcp"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/luarss/openroad-mcp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luarss%2Fopenroad-mcp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luarss%2Fopenroad-mcp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luarss%2Fopenroad-mcp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luarss%2Fopenroad-mcp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luarss","download_url":"https://codeload.github.com/luarss/openroad-mcp/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luarss%2Fopenroad-mcp/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29135047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T20:50:26.975Z","status":"ssl_error","status_checked_at":"2026-02-05T20:49:26.082Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-tools","asic-design","chip-design","eda","fastmcp","mcp","model-context-protocol","openroad","physical-design","python","vlsi"],"created_at":"2025-07-26T04:13:36.393Z","updated_at":"2026-04-01T16:40:48.915Z","avatar_url":"https://github.com/luarss.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenROAD MCP Server\n\n\u003c!-- mcp-name: io.github.luarss/openroad-mcp --\u003e\n\nA Model Context Protocol (MCP) server that provides tools for interacting with OpenROAD and ORFS (OpenROAD Flow Scripts).\n\n## Demo\n\n![OpenROAD MCP Demo](demo/video_gen/demo-quick.gif)\n\n[Watch full demo video](https://youtu.be/UQM1otOl17s)\n\n## Features\n\n- **Interactive OpenROAD sessions** - Execute commands in persistent OpenROAD sessions with PTY support\n- **Session management** - Create, list, inspect, and terminate multiple sessions\n- **Command history** - Access full command history for any session\n- **Performance metrics** - Get comprehensive metrics across all sessions\n- **Report visualization** - List and read report images from ORFS runs\n\n## Requirements\n\n- **OpenROAD** installed and available in your PATH\n  - [Installation guide](https://openroad.readthedocs.io/en/latest/main/GettingStarted.html)\n- **OpenROAD-flow-scripts (ORFS)** for complete RTL-to-GDS flows (optional but recommended)\n  - [ORFS installation guide](https://openroad-flow-scripts.readthedocs.io/)\n- **Python 3.13+** or higher\n- **uv** package manager\n  - Install: `curl -LsSf https://astral.sh/uv/install.sh | sh`\n\n## Support Matrix\n\n| MCP Client | Supported | Transport Mode(s) | Notes |\n|------------|--------|------------------|-------|\n| Claude Code | ✅ | STDIO | Full support for all features |\n| Gemini CLI | ✅ | STDIO | Full support for all features |\n| Other MCP clients | ⚠️ | STDIO | Should work with standard STDIO transport |\n\n## Getting Started\n\n**New to OpenROAD MCP?** Check out our [Quick Start guide](QUICKSTART.md).\n\nFor platform-specific setup instructions, see the [Cross-Platform Guide](docs/CROSS_PLATFORM.md).\n\n### Standard Configuration\n\nThe basic configuration for all MCP clients:\n\n```json\n{\n  \"mcpServers\": {\n    \"openroad-mcp\": {\n      \"command\": \"uvx\",\n      \"args\": [\n        \"--from\",\n        \"git+https://github.com/luarss/openroad-mcp\",\n        \"openroad-mcp\"\n      ]\n    }\n  }\n}\n```\n\nFor local development, use:\n\n```json\n{\n  \"mcpServers\": {\n    \"openroad-mcp\": {\n      \"command\": \"uv\",\n      \"args\": [\n        \"--directory\",\n        \"/path/to/openroad-mcp\",\n        \"run\",\n        \"openroad-mcp\"\n      ]\n    }\n  }\n}\n```\n\n## Installation\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eClaude Code\u003c/b\u003e\u003c/summary\u003e\n\nUse the Claude Code CLI to add the OpenROAD MCP server:\n\n```bash\nclaude mcp add --transport stdio openroad-mcp -- uvx --from git+https://github.com/luarss/openroad-mcp openroad-mcp\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eGemini CLI\u003c/b\u003e\u003c/summary\u003e\n\nFollow the [Gemini MCP install guide](https://ai.google.dev/gemini-api/docs/model-context-protocol), using the [standard configuration](#standard-configuration) above.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eDocker\u003c/b\u003e\u003c/summary\u003e\n\n🚧 **Work in Progress**: Docker deployment via GitHub Container Registry (GHCR) is coming soon.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eMCP Registry\u003c/b\u003e\u003c/summary\u003e\n\nOnce published to the [MCP Registry](https://registry.modelcontextprotocol.io), clients can discover and install directly:\n\n```bash\nuvx openroad-mcp\n```\n\n\u003c/details\u003e\n\n## Verification\n\nAfter configuration, restart your MCP client and verify the MCP server is running:\n\n1. The server should automatically start when your MCP client launches\n2. You can use OpenROAD tools through the MCP interface\n3. Check logs for any startup errors if tools are not available\n\n## Available Tools\n\nOnce configured, the following tools are available:\n\n- `interactive_openroad` - Execute commands in an interactive OpenROAD session\n- `create_interactive_session` - Create a new OpenROAD session\n- `list_interactive_sessions` - List all active sessions\n- `terminate_interactive_session` - Terminate a session\n- `inspect_interactive_session` - Get detailed session information\n- `get_session_history` - View command history\n- `get_session_metrics` - Get performance metrics\n- `list_report_images` - List ORFS report directory images\n- `read_report_image` - Read a ORFS report image\n\n## Troubleshooting\n\nIf the MCP server fails to start:\n\n1. Ensure `uv` is installed and available in your PATH\n2. Verify the path to openroad-mcp is correct\n3. Check that all dependencies are installed: `make sync`\n4. Review your MCP client logs for specific error messages\n\n## Development\n\n### Setup\n```bash\n# Install environment\nuv venv\nmake sync\n```\n\n### Testing\n```bash\n# Run core tests (recommended - excludes PTY tests that may fail in some environments)\nmake test\n\n# Run interactive PTY tests separately (may have file descriptor issues in CI)\nmake test-interactive\n\n# Run all tests including potentially problematic PTY tests\nmake test-all\n\n# Format and check code\nmake format\nmake check\n```\n\n**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.\n\n### MCP Inspector\n```bash\n# Launch MCP inspector for debugging\n# For STDIO transport: Set Command as \"uv\", Arguments as \"run openroad-mcp\"\nmake inspect\n```\n\n## Contributing\n\nWe welcome contributions to OpenROAD MCP! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for detailed instructions on how to get started, our development workflow, and code standards.\n\n## Support\n\nIf you encounter any issues or have questions, please open an issue on our [GitHub issue tracker](https://github.com/luarss/openroad-mcp/issues).\n\n## License\n\nBSD 3-Clause License. See [LICENSE](LICENSE) file.\n\n---\n\n*Built with ❤️ by Precision Innovations*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluarss%2Fopenroad-mcp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluarss%2Fopenroad-mcp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluarss%2Fopenroad-mcp/lists"}