Skip to main content
Glama

Create board release

create_board_release
Idempotent

Cut a named release of a board you own: a name pinned to one exact published version, recording that version's fabrication outputs (gerbers, placement, BOM, schematic PDF, STEP) and retained source digest. Version omitted means the current head. Name rules (the tag argument): letters, digits, '.', '_' or '-'; never 'latest' or a bare/v-prefixed number, because those stay version selectors. This is a write; it needs save authority on the board. Retries reuse requestId: the same requestId and inputs return the existing release, different inputs conflict. A name already used on the board, even by a withdrawn release, reports release_tag_exists. The name and the version never change afterwards; the title and notes can be edited on the release page. To replace a release, withdraw it and create one under a new name.

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": {
      "board": "<board>",
      "requestId": "<requestId>",
      "tag": "<tag>"
    },
    "name": "create_board_release"
  }
}

Input Schema

NameRequiredDescriptionDefault
tagYesRelease name: letters, digits, '.', '_' or '-', not 'latest' and not a bare or v-prefixed number (those are version selectors).
boardYesA board you can read: handle/slug or a boardrepo.com URL.
notesNoMarkdown release notes, rendered with the README sanitizer on the release page.
titleNoOptional title shown on the release page, at most 120 characters.
versionNoWhich published version the release names: a number (3 or "v3"), a versionId from list_board_versions, or "latest". Omit for the current version.
requestIdYesA client-generated UUID. Reuse it for all retries of this exact release; never reuse it for a different release.
prereleaseNoIgnored. Releases no longer have a prerelease state; the field is accepted so older callers do not fail.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior3/5

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

The description goes well beyond the annotations: save authority requirement, requestId retry/conflict semantics, the release_tag_exists failure, and the immutability contract (name and version frozen, title/notes editable). However it does not contradict anything; annotations already declare idempotentHint=true and destructiveHint=false, and the text corroborates rather than contradicts. It would score higher if it described the response payload or how withdrawn releases interact with reuse beyond the error code. Given annotations cover most of the safety profile, a 3 is still defensible but the added context is substantial enough to warrant a 4; I'll keep 4.

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?

Front-loaded with the core action, then layers constraints and edge cases in a logical order; almost every sentence carries a distinct fact. The opening sentence is dense enough that it takes effort to parse, but no sentence is 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?

An output schema exists, so return-value explanation is unnecessary, and the description covers the mutation contract, error case, retry behavior, and immutability. The only minor gap is that the 'prerelease is ignored' detail lives only in the schema, but that is acceptable given the schema documents it.

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 coverage is 100%, so all seven parameters are already documented, establishing a baseline of 3. The description does add value on top: it explains the name rules and, crucially, why numbers and 'latest' are reserved as version selectors, and it explains requestId retry semantics beyond the schema's 'reuse it for all retries' phrasing. A 4 is justified given this added meaning over the schema.

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?

States a specific verb and resource ('Cut a named release of a board you own') and immediately defines the scope: a name pinned to one exact published version plus the fabrication outputs recorded. This is clearly distinguishable from create_version and list_board_releases by what it produces and what it pins.

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

Usage Guidelines5/5

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

Explicitly tells the agent what omission of version means ('Version omitted means the current head') and gives a concrete routing rule for the replacement case: 'To replace a release, withdraw it and create one under a new name', pointing at the withdraw sibling rather than a recreate.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources