Skip to main content
Glama

ExducerAI GPU cloud

Search the documentation

search_docs
Read-onlyIdempotent

Search the documentation by keyword. Returns the matching sections with a snippet and the slug to pass to read_doc.

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
limitNoHow many sections to return.
queryYesWhat to look for, in a few words.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds value beyond that by disclosing the return payload shape: matching sections with a snippet plus a slug keyed to the downstream tool. It doesn't state whether results are ranked or what an empty result looks like, so it is not fully transparent.

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 sentences, front-loaded with the action and followed by the return contract. Every clause earns its place, and the reference to read_doc is the single most load-bearing detail in the whole definition.

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 two-parameter read-only search with no output schema, the description supplies the essential missing piece: what comes back (sections, snippet, slug) and what to do with it. What remains unstated is ranking/ordering and empty-result behavior, which are minor for a simple search tool but not nothing.

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%, with both query and limit documented including default and min/max bounds. The description only loosely reinforces the query semantics with "by keyword", offering nothing about matching behavior, syntax, or how limit interacts with ranking, so it sits at the baseline.

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 the documentation by keyword") and immediately distinguishes it from the sibling it feeds into by saying the slug is meant "to pass to read_doc". An agent can tell this is the discovery step, not the read step, without opening either schema.

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

Usage Guidelines4/5

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

The description implies the intended two-step flow: search here first, then use the returned slug with read_doc. That is clear context for when to call it. It stops short of explicit exclusions or failure guidance (e.g. what to do when nothing matches or when a direct slug is already known).

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