Skip to main content
Glama

search_docs

Read-only

Semantic search across a project's documentation. Returns chunks ranked by relevance. Requires the server to have semantic search enabled.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesNatural-language search query
top_kNoMax results (1-50, default 10)
projectYesProject slug (e.g. "nextjs", "react")
versionYesVersion string or "latest"
token_budgetNoMax tokens to budget for results (default 4096)

Schema Changelog

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

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

The description adds context beyond annotations (readOnlyHint, openWorldHint) by disclosing the server-side requirement for semantic search. It does not contradict 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 concise sentences that front-load the purpose and then add the prerequisite. Every sentence is necessary and no filler.

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 search tool with 5 parameters fully defined in schema and no output schema, the description gives sufficient context (semantic search, relevance ranking, server requirement). Could mention how top_k and token_budget affect output, but overall complete.

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?

Input schema has 100% description coverage, so parameters are already well-documented. The description does not add extra meaning or context for any parameter, resulting in a baseline score.

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 clearly states it performs 'semantic search across a project's documentation' and returns 'chunks ranked by relevance', specifying the verb (search) and resource (project docs). It distinguishes from siblings like list_projects and resolve_docs by focusing on semantic search.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Only mentions a prerequisite ('Requires the server to have semantic search enabled'). No guidance on when to use this tool versus siblings (list_projects, list_versions, resolve_docs) or when not to use it.

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.2/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: listing projects, listing versions, resolving documentation URLs, and semantic search. No overlap exists.

Naming Consistency5/5

All tools follow a consistent verb_plural pattern (list_projects, list_versions, resolve_docs, search_docs), making them predictable.

Tool Count5/5

With 4 tools covering project discovery, version exploration, artifact retrieval, and search, the count is well-scoped for a documentation server.

Completeness4/5

The tool surface covers the main read-only operations for documentation projects. A minor gap is the lack of project metadata retrieval beyond versions, but it is sufficient for most use cases.