Skip to main content
Glama

Prepare a board upload

prepare_board_upload
Idempotent

Reserve storage for a new KiCad board or version, after get_board_upload_requirements. A write: use only when the user asked to save this project to BoardRepo. New boards: name and visibility=private_link. Updates: projectId, expectedParentVersionId and the exact current visibility (updates to public boards are public). Returns a secret signed PUT URL for this one ZIP, valid 5 minutes: PUT the exact ZIP with the returned method/headers, no BoardRepo token, then commit_board_upload with the same metadata and operationId. Retry with the same operationId for a fresh URL. Never show or log it. Not saved until committed.

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>",
      "expectedBytes": "<expectedBytes>",
      "contentHash": "<contentHash>"
    },
    "name": "prepare_board_upload"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoRequired when creating a board; omit for an existing board.
messageYesWhat this version changes, at most 500 characters. Use the same text on prepare and commit.
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.
contentHashYesSHA-256 of the exact ZIP bytes to upload, calculated in the assistant's workspace.
operationIdYesA client-generated UUID. Reuse it for all retries of this exact upload; never reuse it for different files or metadata.
expectedBytesYesExact byte length of the ZIP you will PUT.
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.8/5.0
Behavior5/5

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

Annotations already declare a non-read-only, idempotent, non-destructive write; the description adds what the annotations cannot: a secret signed PUT URL with a 5-minute lifetime, no BoardRepo token on the PUT, the requirement to never show or log the URL, and the crucial fact that nothing is persisted until commit.

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 and the safety gate, then the mechanics. It is dense and a few clauses are packed into long sentences, but nearly every sentence carries actionable information; only the 'updates to public boards are public' parenthetical feels slightly redundant with the schema.

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 10-parameter write that hands off to a two-step upload flow, the description covers prerequisite, branch conditions, the returned credential's lifetime and secrecy, and the completion step. Output schema exists, yet the description still explains the essential return value, which is what the agent needs to proceed.

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?

Schema coverage is 100%, so individual field meanings are already documented; the description adds cross-parameter scenario logic (new board = name + visibility=private_link; update = projectId + expectedParentVersionId + exact current visibility) and warns that visibility is never changed here. It stops short of explaining policyHash, contentHash, or expectedBytes usage beyond 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 ('Reserve storage for a new KiCad board or version') and immediately positions it relative to get_board_upload_requirements and commit_board_upload, so the agent can distinguish it from siblings without opening schemas.

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?

Explicit gating ('use only when the user asked to save this project to BoardRepo'), a prerequisite (after get_board_upload_requirements), and branch-specific guidance for new boards vs updates. It also covers the retry path (same operationId) and the required follow-up (commit_board_upload).

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