Skip to main content
Glama

Search documentation

search_docs
Read-onlyIdempotent

Search product documentation by keyword. Returns matching document chunks ranked by relevance.

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": {
      "query": "<query>"
    },
    "name": "search_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
topKNoMax results to return (default 10, max 50)
queryYesSearch query keywords
productNoFilter by product name (optional)
versionNoFilter by version (optional)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare the full safety profile (readOnly, idempotent, non-destructive, closed-world), so the description only needs to add non-annotation behavior. It does contribute one useful fact — results are relevance-ranked document chunks rather than whole documents — but says nothing about pagination, ranking caveats, or how the optional product/version filters interact with the query.

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 short, front-loaded sentences with zero filler: the action first, the return shape second. Nothing is redundant with the title or wasted.

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?

With no output schema, the description must at least characterize the return value, and it does ('document chunks ranked by relevance'). Combined with a fully documented schema and complete annotation set, this is close to sufficient; only a note on result scoping or pagination behavior is arguably 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 description coverage is 100%, so every parameter (query, topK with its default/max, product, version filters) is already documented in the schema. The description adds no syntax, format, or filter-combination guidance beyond that, so the 3 baseline applies.

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?

The description states a specific verb and resource ('Search product documentation by keyword') and even characterizes the result ('matching document chunks ranked by relevance'), so the agent knows exactly what the tool does. However, it never distinguishes this tool from closely related siblings like search_by_tag, get_doc, or get_related_docs, so it stops short of a 5.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance. Given siblings such as search_by_tag (tag-based retrieval) and get_doc (single document retrieval), the absence of any routing advice leaves the agent to infer which retrieval path fits.

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