Skip to main content
Glama

search_docs

Crawl a documentation site and return only the passages that match a query — each with its page URL, line and a relevance score. Token-efficient way to answer a question from docs without packing the whole site.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesThe absolute http(s) URL to start crawling from.
depthNoHow many link hops to follow (0–3, default 1).
queryYesSpace-separated search terms; matching is case-insensitive.
max_pagesNoMax pages to fetch (1–30, default 10).
max_matchesNoMax passages to return (1–50, default 5).
context_charsNoPer-passage character budget (80–4000, default 500).

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Given no annotations, the description carries the full burden. It discloses the crawling behavior, that it returns only matching passages, and the output fields (URL, line, relevance score). It also adds the token-efficiency context. However, it doesn't explicitly state that this is a read-only operation or mention rate limits or error conditions, which would be useful given no annotations.

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. Front-loaded with the core function and output, then a use-case justification.

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?

The description adequately covers the tool's purpose, output format, and use case. It lacks an explicit note about potential network latency or lack of results, but the schema covers all parameter constraints. Given no output schema, the description's outline of return fields is sufficient.

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?

All 6 parameters are fully described in the schema (100% coverage), so the description doesn't need to add parameter details. The description itself doesn't add any extra parameter semantics beyond what the schema provides, so baseline 3 applies.

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?

The description uses a specific verb ('Crawl') and resource ('documentation site'), and specifies the exact return content (passages with page URL, line, relevance score). This clearly distinguishes it from sibling tools like pack_docs or get_file.

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?

It provides clear context for when to use: to answer a question from docs without packing the whole site. However, it does not explicitly mention when not to use or name specific alternatives like pack_docs or search_context.

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.

TDQS

A4.3/5.0
Disambiguation5/5

Each tool has a distinct purpose: get_file for a single file, list_files for repo layout, pack_repo for full repo context, search_context for targeted repo queries, and similarly pack_docs/search_docs for documentation. There is no overlap or ambiguity between tools.

Naming Consistency4/5

All tool names follow a verb_noun pattern (get_file, list_files, pack_docs, pack_repo, search_context, search_docs). The only minor inconsistency is 'search_context' versus 'search_docs'; 'context' is slightly less clear than would be 'search_repo', but the pattern is otherwise consistent.

Tool Count5/5

With 6 tools, the server is well-scoped. Each tool covers a core operation (file access, listing, packing, searching) for two domains (repo and docs). The count feels right for the server's purpose.

Completeness5/5

The tool surface fully covers the domain of context retrieval: you can list files, get a file, pack a repo or docs site, and search for specific passages. There are no obvious missing operations for the stated purpose of packing and searching code and documentation.