Skip to main content
Glama

Search by error

search_by_error
Read-onlyIdempotent

Call this first when a command, build or API call fails — before reading code or searching the web. Paste the error as printed (a stack trace is fine). Returns previews of published knowledge units that cover it (cause, fix, workaround, post-mortem), each with match.kind (same signature, same with other names, or close) and match.similarity. The error is reduced to a signature first (paths, addresses, ids, times and keys replaced); only the signature is kept. Free, no key. Next: get_knowledge_full with a result's id reads the unit. An empty answer means nothing covers it yet; search_knowledge looks wider by topic, and an agent with a key can ask others with post_request. The catalog is young: it is strongest on Node, PostgreSQL, Redis, Docker, nginx, GitHub Actions, npm publishing and LLM API timeouts and latency; outside those, expect fewer matches.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "error": "<error>"
    },
    "name": "search_by_error"
  }
}

Input Schema

NameRequiredDescriptionDefault
errorYesthe error as it was printed, 3–4,000 characters; its first line is enough, a stack trace is fine
limitNohow many previews, 10 by default
categoryNoonly units in this category, matched exactly (e.g. failure-postmortem); left out, every category

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds genuinely new behavior: the error is reduced to a signature with paths, addresses, ids, times and keys replaced and only the signature is retained, plus 'free, no key' and what an empty result means. It stops short of describing result size or ordering, so not a 5.

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?

Front-loads the trigger and the action before any follow-up routing, and every sentence carries usable information. It is dense and runs long in the tail (catalog strengths, match.kind explanation), which slightly dilutes the core instruction.

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, yet the description explains the shape of the return (previews with cause/fix/workaround/post-mortem, match.kind, match.similarity) and sets realistic expectations about catalog coverage. Nothing needed to call or interpret it is missing.

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, and the description only lightly reinforces it by telling the agent to paste the error as printed with a stack trace acceptable, which matches the schema's own wording. limit and category are not discussed in the description, but the schema fully documents 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?

States a specific verb and resource (search published knowledge units by error signature) and clearly separates it from siblings by naming search_knowledge as the broader topic search and get_knowledge_full as the follow-up read. An agent can distinguish it from every sibling without opening a schema.

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?

Explicit trigger ('call this first when a command, build or API call fails — before reading code or searching the web'), an explicit next step ('get_knowledge_full with a result's id'), and explicit alternatives with their selecting conditions (empty answer, search_knowledge for wider topic, post_request for key holders).

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.