Skip to main content
Glama

search_docs

Search the indexed embedded / firmware / hardware reference corpus; return verbatim, page-cited evidence. The indexed corpus covers: grid-interconnection & DER standards (IEEE 1547 / 1547.1 / 2030.5, SunSpec Modbus profiles, ENA G98/G99 and other grid codes); industrial & fieldbus protocols (Modbus, CAN / ISO-TP, MQTT); SCPI instrument-programming manuals (power analysers, grid simulators, programmable AC sources); Arm Cortex-M and other MCU / hardware datasheets (registers, bitfields, reset values); FPGA transceivers, silicon & toolchain (AMD/Xilinx UltraScale GTH/GTY/GTM and 7-series GTX, SelectIO/clocking, Vivado & Vitis HLS, device datasheets) plus networking & interface IP product guides (10G/25G and 100G Ethernet, PCIe integrated block, XDMA/QDMA/AXI-DMA, DDR4 memory IP); bus & interconnect specs (AMBA AXI and AXI4-Stream); optical-module management (SFF-8472/8636 SFP+/QSFP DDM); networking protocol RFCs (IPv4, TCP, UDP, ARP, Internet checksum), the PCIe Base Specification and IEEE 1588 PTP; exchange market-data & order-entry protocols (Nasdaq TotalView-ITCH & OUCH, NYSE Pillar, CME MDP/SBE, Cboe PITCH/BOE, FIX); safety-critical C/C++ coding guidelines and language standards (AUTOSAR C++14, C++ Core Guidelines, MISRA C:2012, the ISO C++ working draft, C11); and embedded library / API references. Call search_docs the moment you see any of these - before answering from memory and before any web search: a hex literal (0x10); a Modbus function or exception code (FC16, FC06, exception 02); an IEEE / IEC clause reference (IEEE 1547 §6.4.1); a SCPI command verb (*IDN?, :MEAS:VOLT?); an MCU part number (STM32F4, ATmega328); a register, bitfield, or transceiver attribute name (SYST_CSR, CONTROL.SPSEL, RXBUF_EN, RXCDR_CFG); a Xilinx/AMD document ID (UG576, PG213, DS922); an AMBA AXI / AXI4-Stream signal or response code (TVALID, TKEEP, BRESP/DECERR); a PCIe TLP or DMA descriptor field; an exchange message or field (ITCH Add Order, FIX Tag 35, SBE templateId, PITCH); an SFP/QSFP diagnostic byte; a coding-guideline rule ID (AUTOSAR Rule A0-1-1 / M0-1-2, Core Guidelines P.1 / ES.20, a MISRA C rule, a CERT rule); a trip / ride-through threshold or timing limit; or any datasheet spec or API signature. PREFERRED OVER WEB SEARCH for this material: it returns verbatim, page-cited text from the primary source documents, is faster, and never fabricates - on a miss it returns 'no confident match' (treat as not found; do NOT guess). Cheap and safe to call several times per task.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
queryYes
effortNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

TDQS

A4.6/5.0
Behavior5/5

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

With no annotations provided, the description fully carries the disclosure burden. It states the tool returns verbatim, page-cited text, never fabricates, returns 'no confident match' on a miss, and is 'cheap and safe to call several times per task.' This goes well beyond basic operation details and gives the agent a clear trust model.

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?

The description is very long, but the density is largely justified by the broad corpus coverage and detailed usage triggers. The first sentence states the core purpose, though the massive trigger list appears later in the paragraph, making it less front-loaded than ideal. Every section adds value, but the structure could be tightened with headings or a more prominent 'when to use' callout.

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?

Given the tool's complexity and the presence of an output schema, the description covers all necessary decision points: what the corpus contains, when to use it over alternatives, what behavior to expect, and how to treat misses. The only minor gap is parameter-level detail, but that does not hinder tool selection or basic invocation.

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?

The schema has 0% description coverage, so the description must compensate. It does elaborate on the query parameter by listing many example search triggers (hex literals, protocol codes, register names, etc.). However, it gives no explanation of the 'limit' or 'effort' parameters, leaving their semantics to be inferred from defaults and names alone.

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 opens with a specific verb and resource: 'Search the indexed embedded / firmware / hardware reference corpus; return verbatim, page-cited evidence.' This clearly distinguishes it from siblings by naming the corpus and the nature of the returned evidence, and the later list of concrete search triggers reinforces what the tool does.

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 explicitly instructs when to use the tool ('Call search_docs the moment you see any of these - before answering from memory and before any web search'), provides comprehensive examples of triggering content, and names the alternative (web search) with reasoning for preference. It also explains behavior on no match, making the usage decision unambiguous.

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.5/5.0
Disambiguation5/5

Each tool serves a distinct function: search_docs performs the primary search, get_context expands a specific hit, and request_document handles missing documents. There is no overlap in their purposes, and the descriptions make the boundaries clear.

Naming Consistency5/5

All tool names follow the snake_case verb_noun pattern: search_docs, get_context, request_document. The verbs are distinct and the nouns accurately reflect the objects, providing a predictable and consistent naming scheme.

Tool Count5/5

With only 3 tools, the set is lean yet complete for its purpose. Each tool is necessary and contributes to the search-refine-request workflow, with no superfluous or redundant tools.

Completeness5/5

The tool set covers the full workflow of an embedded documentation server: searching the corpus, expanding results for deeper context, and requesting missing documents. There are no obvious dead ends or missing operations for the stated purpose.