Skip to main content
Glama

Get board upload requirements

get_board_upload_requirements
Read-onlyIdempotent

Start here before saving KiCad files. Omit board to create a new personal board; supply handle/slug to update your own board. Returns project ID, current parent, visibility, archive limits, required exclusions and defaultOmissions. Include the selected project's schematics, PCB, settings, local libraries and models. Leave out KiCad backups and autosaves (defaultOmissions) unless the user asks to keep them, and always omit requiredExclusions. Optional saved exclusions do not activate silently. The remote server cannot read a local path: the assistant needs file access and HTTP PUT capability. New boards are unlisted and accessible by link, not account-private.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_board_upload_requirements"
  }
}

Input Schema

NameRequiredDescriptionDefault
boardNoFor a new version of one of your boards: its handle/slug or boardrepo.com URL. Omit to create a new board.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), and the description adds genuinely new operational context: the remote server cannot read a local path, the assistant needs file access plus HTTP PUT, and new boards are unlisted and link-accessible rather than account-private. Those are real constraints an agent could not derive from the annotations. It does not describe pagination or size/rate behavior, but that is minor for a requirements lookup.

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?

It is front-loaded with the trigger and the parameter branch, and each sentence carries distinct information about exclusions, file scope, or server capability. The middle stretch about including schematics/PCB/settings/models leans into guidance for the subsequent upload step and makes the paragraph dense, but it is not 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?

With an output schema present the description needn't explain return values, yet it names the key fields anyway, and it flags the local-path limitation that would otherwise cause a silent failure. For a single-optional-parameter read tool this is complete; only the follow-up call sequence is left implicit.

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 description already says 'Omit to create a new board', so the description's omit-vs-supply sentence largely restates it. The added nuance is that supplying a handle/slug updates 'your own board' (ownership constraint) and that saved exclusions do not activate silently. Useful but marginal 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?

The description states a specific verb and resource ('get board upload requirements') and makes the ordering explicit with 'Start here before saving KiCad files', which separates it from prepare/commit-style siblings. It also enumerates what comes back (project ID, parent, visibility, archive limits, requiredExclusions, defaultOmissions), so an agent knows exactly what this call yields before touching any other upload tool.

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

Usage Guidelines4/5

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

It gives a clear when-to-use trigger ('before saving KiCad files') and branches the single parameter's behavior: omit board for a new personal board, supply handle/slug to update your own board. It also states what to include and what to leave out. It does not name a next-step sibling by name, so routing after this call is left to inference.

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