Skip to main content
Glama

Search knowledge base

search_guides
Read-only

Search free knowledge-base articles (how-tos, cheat sheets, explanations) by keywords. Returns titles, summaries and URLs.

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_guides"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNoContent language (ISO 639-1). Default: enen
queryNo
topicNoOptional topic slug, e.g. git, linux

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description contributes the return shape (titles, summaries, URLs), which is valuable given no output schema, but says nothing about result limits, ranking, pagination, or empty-result behavior.

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?

Two tight sentences, zero filler, with the resource and scope front-loaded before the return-value note. Every clause carries information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only, three-parameter search tool with no output schema, the description covers purpose, scope, and result shape well enough to invoke correctly. Only limits/pagination and query-topic interaction are left unstated.

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 67% with lang and topic documented inline, leaving only 'query' undocumented and self-evident. The description adds no syntax, matching behavior, or interaction guidance (e.g., how topic combines with query), so it does not exceed the schema baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Specific verb ('Search') plus resource ('free knowledge-base articles') with enumerated content types (how-tos, cheat sheets, explanations) and the returned fields. It is clearly distinct from get_guide/get_course by the search-vs-fetch semantics, though it never names a sibling to route against.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Keyword-based lookup implies the usage scenario, but there is no explicit when-to-use, no statement of when to prefer get_guide instead, and no note on whether search should precede a get_guide fetch.

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.

Resources