Skip to main content
Glama

search_docs

Read-onlyIdempotent

Search published TanStarter documentation and return ranked public pages. Each result has a title, path, canonical URL such as https://docs.tanstarter.dev/ai, a short excerpt, and locale. Read-only. No authentication. Searches English (en) or Chinese (zh) docs only, never source code, accounts, or private data.

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 number of pages to return.
queryYesText to match against published documentation.
localeNoDocumentation language. English is the default.en

Output Schema

NameRequiredDescriptionDefault
queryYes
localeYes
resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/closed-world, and the description reinforces this with 'Read-only' plus new information the annotations don't carry: 'No authentication' required. It also discloses result fields (title, path, canonical URL, excerpt, locale), though this partially duplicates the output schema.

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?

Front-loaded with the core action and result scope, followed by safety/auth facts and result fields. Mostly efficient, but the enumerated result fields are marginal value given an output schema already exists.

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 rich annotations, full schema coverage, and an output schema, the remaining burden is small: the description supplies auth requirements and corpus boundaries. Nothing essential for correct invocation is 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 all three parameters (query, limit, locale) are already documented with types, defaults, and an enum. The description notes 'English (en) or Chinese (zh)' which echoes the locale enum but adds no new format or constraint detail beyond the schema.

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 ('Search') and a precisely scoped resource ('published TanStarter documentation'), plus the return shape ('ranked public pages'). The scope boundaries ('never source code, accounts, or private data') make it unmistakable what corpus is and isn't searched.

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?

Clearly tells the agent the applicable context (English or Chinese published docs) and explicit exclusions (source code, accounts, private data). No sibling tools exist to route against, so a dedicated when-to-use-vs-alternative clause isn't possible; the exclusions carry the guidance burden.

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