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 how a design is wired and query_design for a file's structure; use this when you need to locate something by name.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boardYesA public board: handle/slug (e.g. alice/keezyboost40) or a boardrepo.com URL. Discover it with search_boards; do not invent one.
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
filesTruncatedYes

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already mark the tool as read-only, idempotent, and non-destructive, and the description adds meaningful behavioral detail beyond them: matching is literal and case-insensitive, not a regular expression, and results include file, line number, and matching line. It also clarifies the optional path_suffix restriction, giving the agent a precise model of how the search behaves.

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?

The description is three dense sentences with no filler: it states the action and benefit, defines matching behavior and options, and closes with routing to alternatives. Every sentence adds information an agent needs, and the key purpose is front-loaded.

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 four-parameter search tool with a full output schema and safety annotations, the description is complete: it explains board discovery, query semantics, optional filtering, and the exact return shape. It also covers sibling differentiation, leaving no obvious gap for an agent to select and invoke the tool 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 description coverage is 100%, so the baseline is 3, but the description enriches parameter meaning with concrete query examples ('USB_DP', 'ATmega328'), explicit literal-search semantics, and an example path_suffix ('.kicad_sch' or '.md'). This goes beyond the schema's property descriptions without having to restate them.

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 names a specific verb and resource: 'find where something appears across a board's text files' in one call, with concrete examples of search targets and the returned fields (file, line number, matching line). It also explicitly distinguishes itself from siblings read_schematic and query_design, making the tool's role unmistakable.

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 clear when-to-use guidance: use it to locate a literal string across a board's files instead of reading files one by one. It also provides explicit exclusions and alternatives: 'Prefer read_schematic for how a design is wired and query_design for a file's structure; use this when you need to locate something by name.'

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.