Skip to main content
Glama

simulate

Compile and run a Verilog testbench with Icarus Verilog from specified source files and an optional top module, verifying a clean exit and no FAIL/ERROR output.

Instructions

Compile and run a Verilog testbench with Icarus Verilog.

sources: files relative to cwd, testbench included. top: testbench module, if ambiguous. The run passes when the simulator exits 0 and prints no FAIL/ERROR text.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "sources": "<sources>"
    },
    "name": "simulate"
  }
}

Input Schema

NameRequiredDescriptionDefault
cwdNo
topNo
sourcesYes
timeout_sNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose meaningful behavior: it shells out to iverilog, runs a simulation, and defines success as exit code 0 plus absence of FAIL/ERROR text. It omits whether build artifacts are written to disk, what happens on timeout expiry, and whether the simulator log is returned or discarded.

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

Conciseness4/5

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

The definition is short and front-loads the core action before the parameter notes and pass criteria. The 'sources:'/'top:' fragments are efficient but border on cryptic, and 'if ambiguous' is an under-specified qualifier rather than a rule.

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 execution tool with no annotations and no output schema, the description supplies the crucial pass/fail contract, which is genuinely helpful. It still leaves gaps an agent would care about: what the tool returns (log? exit code? artifacts?), default working directory behavior, and timeout handling.

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 0%, so the description must compensate; it explains two of four parameters ('sources' as files relative to cwd including the testbench, 'top' as the testbench module when ambiguous). The 'cwd' and 'timeout_s' parameters get no explanation, and 'if ambiguous' leaves the resolution rule unclear.

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

Purpose4/5

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

The description states a specific verb pair and resource: 'Compile and run a Verilog testbench with Icarus Verilog', which is far more informative than the bare name 'simulate'. It does not explicitly contrast itself with siblings like 'build' or 'program', so the boundary between compiling a project and running a testbench is left implicit.

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?

Usage is implied rather than stated: the pass criteria ('exits 0 and prints no FAIL/ERROR') signals this is for verification runs, and the 'sources' note implies the testbench must be included. There is no explicit when-to-use versus 'build'/'program', and no stated prerequisites such as Icarus Verilog being installed.

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