Skip to main content
Glama

Read a board file

read_file
Read-onlyIdempotent

Use when the user wants the raw contents of a specific file in a public board (a README, config, or a .kicad_sch/.kicad_pcb), by an exact path from list_board_files or one the user gave. Text returns a 128 KiB UTF-8 chunk (pass the returned nextOffset for more); binary returns a download URL, not bytes, so do not claim to have read a binary's contents. Do not guess paths. To understand how a circuit is wired, prefer read_schematic over parsing raw .kicad_sch.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesThe exact file path within the board, as returned by list_board_files. Do not guess.
boardYesA public board: handle/slug (e.g. alice/keezyboost40) or a boardrepo.com URL. Discover it with search_boards; do not invent one.
offsetNoByte offset to start a text file from (default 0); pass the returned nextOffset to continue.

TDQS

A4.9/5.0
Behavior5/5

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

Beyond the readOnly/idempotent annotations, the description discloses critical behavior: text files return a 128 KiB UTF-8 chunk requiring nextOffset pagination, binary files return a download URL rather than bytes, and the agent must not claim to have read binary contents. This is valuable operational context not implied by the schema or annotations.

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?

Every sentence earns its place: use case, return behavior for text and binary, path constraint, and sibling routing. It is front-loaded with the core purpose and contains no filler.

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?

With no output schema, the description fully covers return semantics, pagination, binary handling, and usage boundaries. It also includes guidance about using read_schematic for circuit understanding, making the tool contextually complete for correct invocation.

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 description coverage is 100%, so the baseline is 3. The description adds meaningful semantics by tying path to list_board_files, emphasizing that paths must not be guessed, and explaining that offset accepts the returned nextOffset for continuation.

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 ('read'), a precise resource ('raw contents of a specific file in a public board'), and constrained inputs ('exact path from list_board_files'). It also distinguishes itself from siblings by explicitly excluding raw .kicad_sch parsing in favor of read_schematic.

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?

It explicitly says when to use the tool: when the user wants raw file contents by an exact path. It gives clear exclusions ('Do not guess paths') and directs the agent to read_schematic for understanding circuit wiring, providing a concrete alternative.

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.

TDQS

A4.7/5.0
Disambiguation5/5

Each tool targets a distinct resource and action: board metadata, BOM, stored checks, file listing, fab profiles, structured queries, raw file contents, schematic connectivity, running checks, text search within a board, and board search across the corpus. Even similar pairs like get_checks/run_checks and search_board/search_boards are clearly separated by their descriptions and intended use.

Naming Consistency5/5

All tools follow a consistent snake_case verb_noun pattern, with get_, list_, read_, query_, run_, and search_ prefixes that accurately signal their behavior. There are no style mixes or ambiguous generic verbs.

Tool Count5/5

Eleven tools is well within the ideal range and each tool earns its place by covering a distinct aspect of board discovery, retrieval, and design inspection. The set feels complete without redundancy or bloat.

Completeness5/5

The tool surface covers the full read-side workflow: searching boards, fetching metadata and BOMs, inspecting schematic connectivity, reading raw or structured files, listing fabrication profiles, and retrieving or running DRC/ERC checks. No obvious gaps exist for a read-only public KiCad board repository browser.