Skip to main content
Glama

Search Module Manuals

search_manual
Read-onlyIdempotent

Full-text search across parsed module manuals, product pages, and firmware release notes.

Use this only when the question is about content that lives in continuous prose rather than in typed fields:

  • Procedural: calibration sequences, button combos, factory-reset steps, save/load procedures.

  • Diagnostic: LED color meanings, error indicators, troubleshooting trees.

  • Firmware specifics beyond the short notes on firmware_versions (which only carry the headline change).

  • Panel walkthroughs and prose explanations that aren't captured as parameters/jacks/zones.

Do NOT call this for content already in get_module: a parameter's behavior, a jack's signal type or polarity, a mode's name or description, capability tags, HP, or power draw. Those are typed and authoritative there.

Do NOT call this to summarize a module — that's get_module's job. search_manual returns excerpts, not summaries.

Returned chunks are source prose, not typed facts. Read them to ground your answer, then paraphrase and point the user to the source to verify (cite-and-point, not reproduce — SKILL.md §8). text is capped (~800 chars); the full passage is at audit_url.

Args:

  • query (string, required): search terms. Plain words are AND'd by default ("calibration LED" matches chunks mentioning both). If the AND match returns 0 rows, the server retries with OR (any-token match) and sets _meta.relaxed_to_or=true on the response — so a long natural-language query like "cascade mode time inner outer delay" still surfaces something useful instead of zeroing out. Best practice is still 2–4 distinctive keywords; the OR fallback is a safety net, not a substitute. Query is tokenized to alphanumeric runs; FTS5 punctuation is stripped.

  • module_id (string, optional): "/" — restrict to one module. Strongly recommended when the user has named a module.

  • source_id (integer, optional): restrict to one source. Use when you already have a source_id from get_source / list_references and want to dig into that specific document.

  • source_type (string, optional): one of "manual", "product_page", "firmware_notes". Defaults to all.

  • limit (integer, optional): default 5, max 20. Smaller is usually better — top-3 hits cover most queries.

Returns: { "query": string, "matches": [{ "chunk_id": number, "source_id": number, "source_type": string, "source_title": string | null, "module_id": string | null, "heading_path": string, // "Calibration > Tuning Procedure" "snippet": string, // BM25-highlighted excerpt with [matches] in brackets "text": string, // chunk text, capped ~800 chars; paraphrase, don't paste "truncated": boolean, // true if text was trimmed; full passage at audit_url "audit_url": string, // human-readable audit page for the source "rank": number // BM25 score (more negative = better match) }], "total": number, // total matches across the corpus (capped at 200) "_meta": { "kind": "manual_excerpt", "query": , "relaxed_to_or": true // only present when AND returned 0 and OR retry fired } }

Examples:

  • "How do I calibrate Plaits' V/Oct?" → { query: "calibration V/Oct", module_id: "mutable-instruments/plaits" }

  • "What does the red LED on Marbles mean?" → { query: "red LED", module_id: "mutable-instruments/marbles" }

  • "How do I reset Pamela's New Workout to defaults?" → { query: "factory reset defaults", module_id: "alm-busy-circuits/pamelas-new-workout" }

  • "What changed in Plaits firmware 1.2?" → { query: "1.2", module_id: "mutable-instruments/plaits", source_type: "firmware_notes" }

Errors:

  • Returns matches=[] with total=0 if nothing matches. Not an error.

  • Errors only on malformed input (missing query, invalid limit, unknown source_type).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
queryYesSearch terms.
module_idNo
source_idNo
source_typeNo

TDQS

A4.9/5.0
Behavior5/5

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

Beyond the readOnlyHint and idempotentHint annotations, the description explains the AND/OR fallback with _meta.relaxed_to_or, tokenization of punctuation, the ~800-char cap on text, and that chunks are source prose to be paraphrased. No contradiction with annotations.

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 well-structured with clear sections: purpose, usage guidelines, args, return format, examples, and errors. It is long but information-dense; minor redundancy exists in emphasizing that returned excerpts are not summaries, repeated in two places.

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?

The tool is moderately complex (5 params, no output schema) but the description covers every aspect: full return object shape, concrete examples with real module IDs, error behavior, and citation guidance. An agent can confidently select and invoke it without further context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 20% (only 'query' has a one-line description). The description compensates fully: query's AND/OR behavior and best practices, module_id's format and recommendation, source_id's relation to get_source/list_references, source_type's enum values, and limit's default/max and recommendation.

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: 'Full-text search across parsed module manuals, product pages, and firmware release notes.' This clearly distinguishes it from sibling tools like get_module (typed fields) and search_modules (module metadata).

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?

It explicitly states when to use the tool ('Use this only when the question is about content that lives in continuous prose') and when not to use it, naming get_module as the alternative for typed facts. Also provides best practices for query formulation and module_id usage.

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

Each tool targets a distinct resource/action: get_module(s) for specs, search_modules for filtered queries, resolve_modules for name mapping, find_compatible_with for per-module relations, reachable_pairings/techniques for rack-level analysis. Minor overlap between get_module/get_modules and the relationship tools (find_compatible_with vs reachable_pairings) could cause misselection, but descriptions clarify scope.

Naming Consistency3/5

Mostly verb_noun snake_case (get_, search_, find_, resolve_, visualize_, report_, lookup_), but three tools break the pattern: rack_redundancy, reachable_pairings, reachable_techniques use noun/adjective phrases without a verb. The get_* cluster is consistent but the overall set mixes conventions.

Tool Count4/5

17 tools is slightly above the ideal 3-15 range but justified by the server's broad scope: module specs, search, manuals, relationships, rack analysis, visualization, and feedback. Each tool has a clear role; the count is reasonable for the domain's complexity.

Completeness5/5

The surface covers the full read-only Eurorack knowledge workflow: module lookup (get_module, search_modules, resolve_modules), manual prose (get_manual_chunk, search_manual), concepts (lookup_concept), techniques (search_techniques, find_role_realizations), compatibility (find_compatible_with, reachable_pairings), rack analysis (reachable_techniques, rack_redundancy), visualization, and provenance (get_source). report_gap even enables self-improvement. No obvious missing operations.

Resources