Skip to main content
Glama

build

Compile HDL sources into an FPGA bitstream as a background job from a project directory and top module, with optional part, source, and constraint overrides.

Instructions

Start a full build (synthesis to bitstream) as a background job.

project_dir: folder with the HDL sources (copied to the build machine; old outputs are skipped). top: top module name. If .xst exists in the folder, the project's own synthesis script is used. part: device-package-speed, e.g. xc3s700a-fg484-4. Defaults to the selected board's part. The part selects the add-on. sources: paths relative to project_dir; default is every .v/.vhd in the folder except testbenches. constraints: constraints file relative to project_dir; default is the only .ucf (ISE) or .cst (Gowin) in the folder. backend: force a specific add-on. By default the usable add-on with the highest priority is used (the vendor tool when the user has it, otherwise the open-source flow).

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": {
      "project_dir": "<project_dir>",
      "top": "<top>"
    },
    "name": "build"
  }
}

Input Schema

NameRequiredDescriptionDefault
topYes
partNo
backendNo
sourcesNo
constraintsNo
project_dirYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/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 and does well: it discloses that this runs as a background job, copies sources to a build machine, skips old outputs, may use a project's own synthesis script, and chooses a backend by priority. It does not explain how the job is identified or monitored, which remains a gap.

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 front-loaded with the core action and then organizes parameter details compactly. Every sentence adds useful semantics for a six-parameter build tool, with no filler.

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?

For a complex background build with no output schema and no annotations, the description covers inputs and build behavior well, including source handling, synthesis script selection, and backend priority. It is slightly incomplete because it does not say what the background job returns or how progress is tracked.

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

Parameters5/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 fully, and it does: project_dir, top, part, sources, constraints, and backend are each given meaning, defaults, and relevant conditions. The parameter explanations add substantial value beyond the schema's bare types and titles.

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 and resource: start a full build from synthesis to bitstream as a background job. This clearly distinguishes the tool from siblings like build_status and simulate by defining a complete build flow.

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 when to use it by describing a full build and default behaviors, but it does not explicitly say when not to use it or name alternatives such as build_status for monitoring after starting the job. Guidance is present but incomplete for tool selection.

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