Skip to main content
Glama

search_docs

Read-onlyIdempotent

Search published MkSaaS documentation and return ranked public pages. Each result has a title, path, canonical URL such as https://mksaas.com/docs/..., and a short excerpt. 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

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so 'Read-only' in the description is redundant. 'No authentication' and the locale coverage add genuinely new operational context, but the rest of the sentence describes return fields that the output schema already documents.

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?

Three tight sentences with the core purpose front-loaded and the negative scoping after. The middle sentence enumerating result fields is largely recoverable from the output schema, so a sliver of it fails to earn its place.

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 full schema coverage, rich annotations and an output schema, the remaining burden is small and the description covers corpus, safety and locale. Minor unstated items — ranking criteria, behavior on zero matches — are not blocking for a simple search call.

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 query, limit and locale already carry their own docs and the enum is defined in the schema. The description corroborates the locale constraint but adds no query syntax, matching behavior, or ranking hints beyond what the schema provides.

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?

Names a specific verb (Search) and resource (published MkSaaS documentation) plus the return shape (ranked public pages). The scope is bounded precisely — English or Chinese published docs only — so an agent knows exactly what corpus this queries.

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?

Explicitly states what the tool will never touch: source code, accounts, or private data, which functions as clear when-not guidance. No alternatives exist (no sibling tools), so it loses nothing for not naming one, but it doesn't say anything about phrasing queries or when results may be empty.

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