Skip to main content
Glama

Save a board version

commit_board_upload
Idempotent

After the signed PUT succeeds, validate and save the KiCad upload as a new board or immutable version. Reuse prepare_board_upload's uploadId, operationId, policyHash, message, visibility and expected parent. The full uploaded file tree becomes the new version. A large save can answer state 'pending': it was accepted and is still running, so follow it with get_board_operation after retryAfterMs instead of committing again. On timeout use get_board_operation; retry the same commit, never invent a new operation ID. A head_moved error requires reading the newer version and reconciling changes before a fresh upload. Returns source persistence and rendering status separately with board/version URLs; saved does not mean rendered or reviewed.

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": {
      "visibility": "<visibility>",
      "operationId": "<operationId>",
      "policyHash": "<policyHash>",
      "message": "<message>",
      "archiveProtocolVersion": "<archiveProtocolVersion>",
      "uploadId": "<uploadId>"
    },
    "name": "commit_board_upload"
  }
}

Input Schema

NameRequiredDescriptionDefault
messageYesWhat this version changes, at most 500 characters. Use the same text on prepare and commit.
uploadIdYesuploadId returned by prepare_board_upload.
projectIdNoExisting personal project ID from get_board_upload_requirements; omit to create a board.
policyHashYespolicyHash from get_board_upload_requirements, unchanged.
visibilityYesExplicit visibility acknowledgment: private_link for new boards (unlisted and accessible by link); exact current visibility for updates. This never changes visibility.
operationIdYesA client-generated UUID. Reuse it for all retries of this exact upload; never reuse it for different files or metadata.
archiveProtocolVersionYesConfirm the packaging contract returned by get_board_upload_requirements.
expectedParentVersionIdNoRequired for an existing board: the head returned by get_board_upload_requirements.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior4/5

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

Goes well past the annotations: it discloses the async 'pending' state, that a commit may be accepted but still running, the retry discipline around operationId, the head_moved conflict mode, and the crucial caveat that 'saved does not mean rendered or reviewed'. It does not contradict idempotentHint=false... rather it reinforces idempotentHint=true by specifying operationId reuse. Remaining gap is minor: no mention of auth/permission requirements or what gets rejected before validation.

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 action, then recovery rules in descending likelihood order. Dense but nearly every clause carries operational meaning; the 'Returns source persistence and rendering status...' sentence partly duplicates the output schema and could be trimmed.

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

Completeness5/5

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

For a mutation tool with async acceptance, conflict errors and retry semantics, the description covers the full failure envelope an agent must handle. An output schema exists, so return-shape detail is not owed, and the one return caveat it does give (saved != rendered) is the semantically important one.

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% and the schema already documents provenance for uploadId, policyHash, operationId, message and visibility. The description's 'reuse prepare_board_upload's ...' sentence largely restates that, adding only the grouping of the six carry-over values; no new syntax, format or constraint detail is supplied.

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 ('validate and save the KiCad upload as a new board or immutable version') and anchors it to a precondition ('after the signed PUT succeeds'), which distinguishes it from prepare_board_upload and from version-listing/reading siblings.

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?

Gives explicit sequencing (only after the signed PUT succeeds), explicit branching for the 'pending' case (call get_board_operation after retryAfterMs, do not commit again), explicit timeout handling, and an explicit precondition for head_moved (read the newer version and reconcile before a fresh upload). When-not and alternatives are both named.

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