BoardRepo

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. Prefer read_schematic for schematic wiring and read_pcb for copper vias/pads/tracks over parsing raw .kicad_sch/.kicad_pcb.

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>",
      "path": "<path>"
    },
    "name": "read_file"
  }
}

Input Schema

Name	Required	Description
`path`	Yes	The exact file path within the board, as returned by list_board_files. Do not guess.
`board`	Yes	A board: handle/slug or a boardrepo.com URL. Use search_boards for public boards or list_my_boards for personal and authorised organisation boards. Do not invent references.
`offset`	No	Byte offset to start a text file from (default 0); pass the returned nextOffset to continue.
`version`	No	Which saved version to read: a version number (3 or "v3"), a versionId from list_board_versions, "latest", or a release tag such as "rev-A". Omit for the latest version. Results echo the version they read; pass its id back to stay on it.

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedNov 8, 2026

addedInput schema / properties / version

Added value: +{
+  "anyOf": [
+    {
+      "minimum": 1,
+      "type": "integer"
+    },
+    {
+      "maxLength": 64,
+      "minLength": 1,
+      "type": "string"
+    }
+  ],
+  "description": "Which saved version to read: a version number (3 or \"v3\"), a versionId from list_board_versions, \"latest\", or a release tag such as \"rev-A\". Omit for the latest version. Results echo the version they read; pass its id back to stay on it."
+}

Changed1 schema field changedSep 14, 2026

changedInput schema / properties / board / description

Previous value: -"A public board: handle/slug (e.g. alice/keezyboost40) or a boardrepo.com URL. Discover it with search_boards; do not invent one."New value: +"A board: handle/slug or a boardrepo.com URL. Use search_boards for public boards or list_my_boards for personal and authorised organisation boards. Do not invent references."

First observedAug 27, 2026

TDQS

A4.6/5.0

Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds behavior they cannot express: 128 KiB UTF-8 chunking with nextOffset continuation, and that binaries yield a download URL rather than bytes. The warning not to claim to have read a binary's contents is exactly the kind of disclosure that prevents a wrong answer.

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?

Four dense sentences with the trigger condition front-loaded and no filler; every clause carries a constraint or a routing rule. It is slightly packed — chunk size, binary behavior, path rule and alternatives all in one block — but nothing is wasted.

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?

There is no output schema, so the description takes on the burden of explaining return shapes, and it does: text chunks with nextOffset versus a URL for binaries. Combined with the path-sourcing caveat and sibling routing, an agent has everything needed to call and interpret it correctly.

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 path, board, offset and version are already documented in the schema, which sets the baseline at 3. The description reinforces the path-sourcing rule and offset continuation, but never mentions the version parameter or its accepted forms, so it adds little 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 ("raw contents of a specific file in a public board") and names the file types it applies to. It also explicitly distinguishes itself from read_schematic and read_pcb, so an agent can pick the right tool without opening either schema.

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?

Opens with an explicit "Use when..." condition, adds a hard exclusion ("Do not guess paths") and routes to the correct alternative for structured schematic/PCB data. The condition selecting read_schematic/read_pcb over raw parsing is spelled out rather than implied.

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

All BoardRepo tools Inspect

Try in Browser

Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.