Skip to main content
Glama
Sign In

Schematik

by io.schematik
OverviewDiscussionsAdmin

Search build guides

search_build_guides
Read-onlyIdempotent

Search published Schematik build guides: complete projects with parts, wiring and firmware. Leave query empty to list featured guides first. Returns a JSON list of guides with a link and a remixUrl; pass a result's slug to get_build_guide for the full guide.

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": "search_build_guides"
  }
}

Input Schema

NameRequiredDescriptionDefault
boardNoOnly return guides for this board. Omit for all boards.
limitNoHow many guides to return at most. Fewer come back when fewer guides match.
queryNoWhat the project should do or use, matched against guide titles, descriptions and boards, e.g. 'weather station'. Leave empty to browse guides, featured ones first.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / limit / description
      Previous value: -"Most results to return."New value: +"How many guides to return at most. Fewer come back when fewer guides match."
    • changedInput schema / properties / query / description
      Previous value: -"Words to match in guide titles, descriptions and board, e.g. 'weather station'. Leave empty to list guides, featured ones first."New value: +"What the project should do or use, matched against guide titles, descriptions and boards, e.g. 'weather station'. Leave empty to browse guides, featured ones first."
  2. Changed3 schema fields changed
    • addedInput schema / properties / board / description
      Added value: +"Only return guides for this board. Omit for all boards."
    • addedInput schema / properties / limit / description
      Added value: +"Most results to return."
    • addedInput schema / properties / query / description
      Added value: +"Words to match in guide titles, descriptions and board, e.g. 'weather station'. Leave empty to list guides, featured ones first."
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and closed-world scope, so safety is covered. The description adds real value beyond them: it scopes results to published guides, discloses the return shape (JSON list with link and remixUrl) and explains the empty-query featured ordering, which the annotations cannot convey.

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 tight sentences, front-loaded with purpose, then browse behavior, then return shape and handoff. Every sentence carries information an agent needs and none of it repeats the title verbatim.

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?

No output schema exists, and the description compensates by describing the returned list, its link/remixUrl fields, and the slug needed to chain into get_build_guide. For a three-parameter read-only search tool, nothing an agent needs to call it correctly is missing.

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 board, limit and query are all documented, including the empty-to-browse behavior. The description reinforces the empty-query semantics but adds no syntax or format detail the schema does not already provide; with full schema coverage, the baseline 3 is appropriate.

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 ('Search published Schematik build guides') and immediately defines what a guide is: 'complete projects with parts, wiring and firmware.' It also distinguishes itself from get_build_guide by framing itself as the search step that yields slugs for that sibling.

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?

Gives clear usage context: leave query empty to browse featured guides first, and pass a result's slug to get_build_guide for the full guide. That is an explicit when-to-use and next-step handoff. It stops short of stating exclusions (e.g. drafts, unpublished content) or when another search tool is preferable, so it is not quite a 5.

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

All Schematik toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources