Skip to main content
Glama

GStars docs

Search documentation

search_docs
Read-onlyIdempotent

Find GStars documentation pages matching a question or keywords (case-insensitive), ranked by relevance with a text snippet. Use it before get_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
limitNoMaximum results, up to 20.
queryYesWords to find, for example "health score" or "deprecation".

Output Schema

NameRequiredDescriptionDefault
queryYes
resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/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 closed-world, so the safety profile is covered. The description adds genuinely new behavior beyond that: matching is case-insensitive, results are relevance-ranked, and each result carries a text snippet. It does not describe pagination or how many characters the snippet contains, but the output schema exists to cover result shape.

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 sentences, both earning their place, with the core matching behavior front-loaded and the workflow hint last. Nothing is redundant with the title or annotations.

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 a full schema, an output schema, and rich annotations, the description supplies enough for correct invocation, including the case-insensitivity and ranking behavior. The only remaining gap is an explicit contrast with list_docs for agents deciding between the two discovery tools.

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 in the schema itself, so the baseline is 3. The description's mention of "a question or keywords" loosely reinforces the query parameter's intent but adds no syntax, format, or limit-related meaning beyond the schema.

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 names a specific verb ("Find") and resource ("GStars documentation pages") and states the matching and ranking behavior. It partly differentiates from siblings by pointing at get_doc as the follow-up, though list_docs is never mentioned, so the distinction from a listing tool is left implicit.

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?

"Use it before get_doc" gives an explicit workflow order, which is real when-to-use guidance for an agent. It stops short of stating when not to use it or how it relates to list_docs, so no exclusions or full alternative comparison is provided.

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