Skip to main content
Glama

Search inside a board's files

search_board
Read-onlyIdempotent

Use to find where something appears across a board's text files in ONE call, instead of reading files one by one: give a literal string (a net name, a reference designator, a part number, a footprint) and get back the file, line number and matching line for each hit. Optionally restrict to a file extension with path_suffix. Matching is literal and case-insensitive, not a regular expression. Prefer read_schematic for schematic wiring, read_pcb for copper vias/pads/tracks, and query_design for a file's structure; use this when you need to locate something by name.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boardYesA 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.
queryYesThe literal text to find, e.g. "USB_DP" or "ATmega328". Not a regular expression.
max_resultsNoOptional cap on matches returned (default 100).
path_suffixNoOptional. Only search files ending with this, e.g. ".kicad_sch" or ".md".

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNo
queryYes
hasMoreYes
matchesYes
filesScannedYes
filesSkippedYes
bytesTruncatedYes
filesTruncatedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • 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."
  2. Changed2 schema fields changed
    • addedOutput schema / properties / bytesTruncated
      Added value: +{
      +  "type": "boolean"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "query",
      -  "matches",
      -  "filesScanned",
      -  "filesSkipped",
      -  "filesTruncated",
      -  "hasMore"
      -]New value: +[
      +  "query",
      +  "matches",
      +  "filesScanned",
      +  "filesSkipped",
      +  "filesTruncated",
      +  "bytesTruncated",
      +  "hasMore"
      +]
  3. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, and non-destructive behavior. The description adds meaningful behavioral detail beyond that: matching is literal and case-insensitive, not regex, and hits return file, line number, and matching line. It does not mention rate limits or performance characteristics, but the existing coverage makes this adequate.

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?

Three sentences with no waste: the core action is front-loaded, followed by examples, matching rules, and sibling routing. Every sentence contributes distinct information and the structure makes scanning easy.

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 4-parameter search tool with an output schema and safety annotations, the description is complete. It explains what a hit returns, how matching behaves, how to limit file types, and which sibling tools cover related but different intents. Nothing essential is missing for an agent to invoke it correctly.

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 the baseline is 3. The description adds semantic value beyond the schema by giving concrete query examples ('net name, reference designator'), explaining the purpose of path_suffix ('restrict to a file extension'), and reinforcing that query is literal, not a regular expression.

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 uses a specific verb ('find where something appears') and a clear resource ('a board's text files'), with examples of what can be searched. It explicitly contrasts with reading files one-by-one and names sibling tools it is not, so an agent can distinguish it immediately.

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?

The description gives explicit when-to-use and when-not-to-use guidance: 'Prefer read_schematic for schematic wiring, read_pcb for copper vias/pads/tracks, and query_design for a file's structure; use this when you need to locate something by name.' This is direct, actionable routing.

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.