Skip to main content
Glama
zesun33

@zesun33/mcp-yosys

by zesun33

@zesun33/mcp-yosys

Model Context Protocol (MCP) server for open-source RTL synthesis, cell statistics, and latch triage via Yosys.

License: Apache-2.0 Protocol: MCP Runtime: Rootless Podman

mcp-yosys equips AI coding agents and IDEs (Cursor, Windsurf, GitHub Copilot / OpenAI Codex, Claude Code, Google Antigravity, OpenCode, Cline) with structured tools to synthesize Verilog/SystemVerilog designs, inspect cell hierarchies, and triage synthesis hazards (such as unintended transparent latches and combinational loops) before committing code to ASIC or FPGA physical design flows.


⚡ Quick Tour: See It in Action

Why AI Agents Need mcp-yosys

Without mcp-yosys (Raw Yosys CLI)

With mcp-yosys (Structured MCP)

Dumps 500+ lines of techmap & ABC logs into context

Structured JSON with < 100 tokens of clean metrics

Inferred latches buried in intermediate RTLIL logs

Pinpointed latch alerts: "variable": "q", "line": 8

Agent blindly guesses gate count and area footprint

Direct cell breakdown ($_AND_, $_DFF_P_, $_XOR_)

Unresolved blackboxes silently fail downstream P&R

Explicit missingModules validation

Requires manual installation of Yosys, ABC, and libs

Zero host configuration (runs via isolated rootless Podman)

Real Agent Scenarios in 60 Seconds

1. Probing the Environment (Zero-Config Verification)

// Tool Call: yosys_toolchain_info
{
  "runtime": "podman",
  "image": "localhost/zesun33/asic",
  "yosysVersion": "Yosys 0.38+92 (git sha1 84116c9a3)",
  "availableTargets": ["generic", "ice40", "sky130"]
}

2. Instant Latch Detection & Triage (130ms)

// Tool Call: yosys_check_latch {"verilog_sources": ["latch_demo.v"], "top_module": "latch_demo"}
{
  "success": true,
  "hasLatches": true,
  "latches": [
    {
      "module": "latch_demo",
      "variable": "q",
      "line": 8,
      "rawMessage": "Latch inferred for signal `\\latch_demo.\\q' from process `\\latch_demo.$proc$latch_demo.v:8$1'"
    }
  ],
  "hasCombinationalLoops": false,
  "warnings": [
    "Latch inferred for signal `\\latch_demo.\\q' from process `\\latch_demo.$proc$latch_demo.v:8$1': $auto$proc_dlatch.cc:433:proc_dlatch$15"
  ]
}

3. Gate-Level Synthesis & Cell Accounting (220ms)

// Tool Call: yosys_synthesize {"verilog_sources": ["counter.v"], "top_module": "counter", "target": "generic"}
{
  "success": true,
  "topModule": "counter",
  "target": "generic",
  "cellCount": 10,
  "cellsByType": {
    "$_AND_": 2,
    "$_DFFE_PN0P_": 4,
    "$_NOT_": 1,
    "$_XOR_": 3
  },
  "wireCount": 8,
  "warnings": [],
  "errors": []
}

4. Design Hierarchy & Blackbox Inspection (140ms)

// Tool Call: yosys_hierarchy {"verilog_sources": ["hierarchy_demo.v"], "top_module": "alu_top"}
{
  "success": true,
  "topModule": "alu_top",
  "modules": [
    { "name": "alu_top", "isTop": true, "submodules": ["adder", "sub"] },
    { "name": "adder", "isTop": false, "submodules": [] },
    { "name": "sub", "isTop": false, "submodules": [] }
  ],
  "missingModules": []
}

Related MCP server: EDA Tools MCP Server

Tools Exposed

Tool

Parameters

Engine

Description

yosys_synthesize

verilog_sources: string[], top_module: string, target?: "generic" | "ice40" | "sky130", flatten?: boolean, output_netlist?: string, cwd?: string, timeout_ms?: number

yosys synth

Synthesizes RTL design to generic logic gates, iCE40 FPGA, or Sky130 standard cells, returning structured cell counts.

yosys_check_latch

verilog_sources: string[], top_module: string, cwd?: string, timeout_ms?: number

yosys check

Fast RTL elaboration pass to detect inferred transparent latches, combinational loops, and multiple drivers with source line numbers.

yosys_hierarchy

verilog_sources: string[], top_module: string, cwd?: string, timeout_ms?: number

yosys hierarchy

Analyzes module instantiation tree and verifies that no submodules or blackboxes are missing.

yosys_toolchain_info

none

Probe

Returns active container/host runtime and Yosys synthesis engine version.


Execution Runtime

mcp-yosys automatically executes commands inside the zesun33/asic rootless Podman container (localhost/zesun33/asic), ensuring consistent synthesis across any Linux host:

  • Container mount: -v <workspace>:/workspace:Z -w /workspace

  • Yosys version: 0.38+92 with ABC integration

  • Rootless storage option: --storage-opt overlay.ignore_chown_errors=true

To configure a custom container image or force local host execution:

export MCP_YOSYS_IMAGE=localhost/zesun33/fpga    # Use FPGA image instead of ASIC
export MCP_YOSYS_RUNTIME=host                    # Use host-installed yosys

Universal Client & AI IDE Setup

Because mcp-yosys implements the standard Model Context Protocol (MCP), it connects seamlessly to any MCP-compliant AI IDE or agent interface:

Environment

Supported Tools

Setup Location

AI IDEs

Cursor, Windsurf, Google Antigravity, Zed

.cursor/mcp.json or .windsurf/mcp.json

Extensions

GitHub Copilot / OpenAI Codex, Cline, Roo Code

VS Code MCP extension settings

CLI Agents

Claude Code, OpenCode, Goose, Antigravity CLI (agy)

Global MCP configuration or CLI flags

Desktop

Claude Desktop

claude_desktop_config.json

1. Cursor / Windsurf / Antigravity IDE

Add to your project's .cursor/mcp.json or .windsurf/mcp.json:

{
  "mcpServers": {
    "yosys": {
      "command": "node",
      "args": ["/data/mxm6982/projects/personal-projects/mcp-yosys/dist/index.js"]
    }
  }
}

2. VS Code (GitHub Copilot / OpenAI Codex / Cline)

Add to your VS Code MCP settings or user configuration:

{
  "mcpServers": {
    "yosys": {
      "command": "node",
      "args": ["/data/mxm6982/projects/personal-projects/mcp-yosys/dist/index.js"]
    }
  }
}

3. Claude Desktop & Claude Code

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "yosys": {
      "command": "node",
      "args": ["/path/to/personal-projects/mcp-yosys/dist/index.js"]
    }
  }
}

Verification & Testing

Run the full 6-gate verification suite:

./scripts/verify.sh

Run specific test tiers:

npm run test:unit       # Fast unit tests (parsers & contract)
npm test                # Full test suite (including live container synthesis)

Available Tools

4 tools
yosys_check_latchA

Performs fast RTL elaboration and latch checking to identify inferred transparent latches, combinational loops, and multiple drivers with exact source lines.

ParametersJSON Schema
NameRequiredDescriptionDefault
cwdNoWorking directory where source files reside.
timeout_msNoTimeout in milliseconds (default: 20000).
top_moduleYesName of the top-level module to inspect.
verilog_sourcesYesList of Verilog/SystemVerilog source files.

TDQS

A4.1/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the behavioral disclosure burden. It discloses that the tool is fast, performs elaboration, and reports specific issue categories with exact source lines. It does not explicitly state that it is read-only or describe failure/error behavior, but the 'checking' framing implies analysis rather than mutation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, tightly written sentence that front-loads the action and then specifies the concrete outputs. There is no filler, repetition, or content that merely restates the schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description tells an agent what the tool checks and that results include exact source lines, but there is no output schema and no mention of output format, return behavior, or error semantics. For a tool with no annotations and no output schema, this leaves some ambiguity about what the agent will receive after invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the input schema already documents all four parameters. The description adds no parameter-specific meaning beyond the schema, such as how verilog_sources or top_module are used or how timeout_ms affects execution. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific action ('Performs fast RTL elaboration and latch checking') and enumerates exactly what it detects: inferred transparent latches, combinational loops, and multiple drivers with exact source lines. This clearly differentiates it from siblings like yosys_synthesize and yosys_hierarchy.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The context is clear: this tool is for latch checking and RTL elaboration, so an agent can infer it should be used when latch-related issues need identification. It does not explicitly name alternatives or state when not to use it, but the purpose and sibling names make the intended use reasonably obvious.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

yosys_hierarchyA

Inspects module hierarchy, detecting instantiated submodules and flagging missing/unresolved blackboxes.

ParametersJSON Schema
NameRequiredDescriptionDefault
cwdNoWorking directory where source files reside.
timeout_msNoTimeout in milliseconds (default: 20000).
top_moduleYesName of the top-level module.
verilog_sourcesYesList of Verilog/SystemVerilog source files.

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the burden of behavioral disclosure. It does disclose the read-only inspection behavior and the specific flagging function, which is helpful. However, it omits what the output looks like, whether anything is written, and what happens beyond flagging unresolved blackboxes.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence that front-loads the verb and resource and compresses the key behavior into an efficient dependent clause. There is no filler or redundant restating of the tool name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a four-parameter inspection tool with a fully documented schema, the description plus schema covers the basic invocation needs. But with no output schema and no annotations, return format, error behavior, and edge cases such as what exactly counts as a missing blackbox are left unspecified.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all four parameters. The description adds little parameter-level semantics beyond the implicit fact that verilog_sources and top_module are the inputs to the hierarchy inspection. This matches the baseline for full schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('Inspects') and resource ('module hierarchy'), and goes on to name two concrete outcomes: detecting instantiated submodules and flagging missing/unresolved blackboxes. This makes the tool's purpose immediately distinct from the synthesis and toolchain-info siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The tool's inspection focus makes its usage reasonably clear, but the description never explicitly states when to use this tool versus yosys_synthesize or yosys_check_latch. There are no alternatives, exclusions, or prerequisites mentioned, so usage guidance is implied rather than spelled out.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

yosys_synthesizeA

Synthesizes a Verilog/SystemVerilog design using Yosys, mapping to generic gates, iCE40 FPGA, or Sky130 standard cells, and returns structured cell counts and warnings.

ParametersJSON Schema
NameRequiredDescriptionDefault
cwdNoWorking directory where source files reside.
targetNoTarget architecture/library (default: 'generic').
flattenNoWhether to flatten the design hierarchy during synthesis.
timeout_msNoMaximum synthesis timeout in milliseconds (default: 30000).
top_moduleYesName of the top-level module to synthesize.
output_netlistNoOptional output Verilog netlist file path.
verilog_sourcesYesList of Verilog/SystemVerilog source files.

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description must carry the behavioral disclosure burden. It does disclose that the tool returns structured cell counts and warnings and maps to specific targets, but it does not mention side effects such as writing an output netlist, modifying files in cwd, potential long runtime, or failure behavior. These gaps matter for a synthesis tool with no annotation safety profile.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single densely informative sentence with no filler. It front-loads the core action, mentions the key target variants, and ends with the expected output. Every clause contributes useful information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given a 7-parameter tool with no annotations and no output schema, the description gives a useful summary but omits important operational context such as whether output_netlist is actually written, what happens with flatten, or how synthesis results are returned beyond 'cell counts and warnings.' It is adequate for a high-level agent decision but not fully complete for safe invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds high-level context about targets and outputs but does not add meaning beyond the schema for parameters like verilog_sources, top_module, cwd, flatten, timeout_ms, or output_netlist. It does not compensate for or extend the schema details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific action ('Synthesizes a Verilog/SystemVerilog design using Yosys') and identifies the resource and output ('returns structured cell counts and warnings'). It also differentiates from sibling tools by naming synthesis, target mappings, and result data, distinguishing it from latch checking, hierarchy analysis, and toolchain info.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no explicit guidance on when to use this tool versus alternatives such as yosys_hierarchy or yosys_check_latch. It does not state conditions, exclusions, or preferred alternative tools. The sibling context makes the purpose inferable, but the description itself carries no usage guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

yosys_toolchain_infoA

Returns active container/host runtime and version information for the Yosys synthesis engine.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the behavioral burden. It clearly frames the tool as a read-only information call ('Returns ... information'), and adds the active container/host context. It does not detail failure modes or output shape, but the read-only nature is evident for a zero-parameter info tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, tightly written sentence that front-loads the action and result. No filler or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given this is a zero-parameter info tool, the description covers the essential context. It does not provide an explicit return schema, but the phrase 'runtime and version information' gives the agent enough to interpret the result. An explicit note about when Yosys might be unavailable would make it fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters, so parameter-level guidance is unnecessary; the baseline is 4. The description still adds meaning by defining exactly what kind of information the call returns.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('Returns') with a clear resource ('runtime and version information for the Yosys synthesis engine'). This distinguishes it from sibling tools that synthesize or check hierarchy/latches.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies this is the environment/version inspection tool, but it never explicitly states when to use it instead of yosys_synthesize, yosys_check_latch, or yosys_hierarchy. No exclusions or trigger conditions are given, so usage must be inferred.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. 4 tool updatesv0.1.0
    • First observedyosys_check_latch
    • First observedyosys_hierarchy
    • First observedyosys_synthesize
    • First observedyosys_toolchain_info

TDQS

A3.9/5.0
Disambiguation5/5

Each tool targets a distinct concern: synthesis, latch/loop checking, hierarchy inspection, and toolchain information. There is no meaningful overlap in purpose or output, so an agent can select the right tool without ambiguity.

Naming Consistency4/5

All tool names share the clear yosys_ prefix and use snake_case, making them predictable. Minor inconsistency exists because some names are verbs (yosys_synthesize), some are verb+noun (yosys_check_latch), and some are nouns (yosys_hierarchy, yosys_toolchain_info), but the pattern is still readable.

Tool Count5/5

Four tools is a well-scoped set for a focused Yosys server. Each tool provides a distinct capability without unnecessary bloat or duplication.

Completeness4/5

The tool set covers the core Yosys workflow: synthesis, latch checking, hierarchy analysis, and environment info. There are minor gaps such as no explicit netlist export or arbitrary Yosys pass execution, but these are not critical for the apparent purpose.

Maintenance

ActivityMaintained
ResponsivenessNo issues

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    D
    maintenance
    Provides AI assistants with a complete FPGA toolchain for HDL linting, simulation, synthesis, and place-and-route across various hardware targets. It features a GitHub-backed IP core registry that enables users to search for and import MIT-licensed cores directly through their chat interface.
    15
    1
    MIT
  • F
    license
    Not graded
    quality
    C
    maintenance
    Enables AI assistants to analyze RTL simulation and synthesis logs through deterministic tools for compile-log summaries, signal tie-off safety checks, and regression result statistics.
    -
  • F
    license
    A
    quality
    C
    maintenance
    Enables AI coding agents and IDEs to lint, compile, syntax-check, and simulate Verilog/SystemVerilog designs through structured, token-efficient MCP tools with isolated containerized toolchains.
    4
    -

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/zesun33/mcp-yosys'

If you have feedback or need assistance with the MCP directory API, please join our Discord server