Skip to main content
Glama

Search StaffBots docs

search_docs
Read-onlyIdempotent

Search llms-full.txt and the public markdown mirrors. Returns titles, URLs, and short snippets.

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
queryYesWords to find in the public docs.

Output Schema

NameRequiredDescriptionDefault
countYes
queryYes
resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint=false, so the safety profile is fully covered without the description. The description usefully names the underlying corpus, which no annotation conveys, but adds no ranking, matching, or result-limit behavior.

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?

Two short sentences, corpus scope front-loaded, no filler. The return-shape sentence is largely redundant given a dedicated output schema exists, which keeps it from a 5.

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 one-parameter read-only search with annotations and an output schema, the description covers the essentials: what corpus is searched and what comes back. The only meaningful omission is guidance on when to prefer faq_search over this tool.

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?

With 100% schema description coverage and a single required 'query' string, the schema already carries the parameter meaning. The description adds no matching semantics (keyword vs phrase vs boolean) or syntax notes beyond what 'Words to find in the public docs' states, so the baseline of 3 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 gives a specific verb plus the exact corpus it searches (llms-full.txt and public markdown mirrors) and states the return shape, so an agent knows this is a keyword search over public docs. It does not distinguish itself from the sibling faq_search, which is the most likely point of confusion.

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?

The scope ('public docs', 'public markdown mirrors') implicitly tells the agent this is for documentation content rather than account, pricing, or booking lookups. There is no explicit when-to-use rule or named alternative such as faq_search for common questions, so routing must be inferred.

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