Skip to main content
Glama

Zain Ahmed Documentation MCP Server

search_docs

Read-only

Use this tool when searching across all developer documentation, TypeScript SDK guides, OpenAPI specs, architectural blueprints, and runbooks by keyword. Returns ranked matching topics, counts, and relevant excerpts.

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
queryYesKeyword or phrase to search for (e.g. 'Kubernetes', 'Karpenter', 'OpenAPI', 'Auth', 'FinOps')

Output Schema

NameRequiredDescriptionDefault
countYes
queryYes
matchesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds that results are ranked with counts and excerpts, which is genuinely useful behavioral context, but with an output schema present that information is largely redundant and nothing is said about query semantics, limits, or empty-result behavior.

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, no filler: the usage trigger and corpus scope come first, followed by the return characteristics. Every clause carries information.

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 single-parameter read-only search with full schema coverage, annotations, and an output schema explaining return values, the definition covers corpus scope and result type adequately. Minor gaps remain around matching behavior (exact vs fuzzy/stemmed) and result limits, but nothing critical to 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% for the single 'query' parameter, which already documents it as a keyword or phrase with concrete examples ('Kubernetes', 'Karpenter', 'OpenAPI', 'Auth', 'FinOps'). The description's phrase 'by keyword' adds no meaning beyond that, 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 ('searching') and an explicitly enumerated corpus (developer documentation, TypeScript SDK guides, OpenAPI specs, architectural blueprints, runbooks) plus the keyword-based modality. It does not name the sibling get_documentation_page or state how it differs, so an agent must infer the search-vs-fetch split rather than being told.

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 this tool when searching across all developer documentation... by keyword' provides a clear triggering condition and implicitly scopes usage to keyword lookup across the doc corpus. There are no exclusions, prerequisites, or named alternatives, which keeps it short of a 5.

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