Skip to main content
Glama

Coverage Cat

Coverage Cat docs search

docs_search
Read-onlyIdempotent

Search quickstart, auth, sandbox, OpenAPI, and runtime skill docs without installing the optional docs-only MCP server.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
queryYesSearch terms for the documentation need.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/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 openWorldHint=false, so the safety profile is covered without description help. The description adds that this is a search operation and that no extra server is needed, but says nothing about result format, ranking, or how 'limit' bounds results.

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?

A single sentence that front-loads the verb and resource and wastes no words. It is slightly dense with the enumerated doc categories, but every clause contributes to scoping the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only search tool with annotations covering safety and no output schema, the description adequately conveys scope and the built-in-vs-optional-server context. It remains incomplete regarding the undocumented 'limit' parameter and any hint about result count or ordering.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 50%: 'query' is documented in the schema, but 'limit' (integer, min 1, max 10) has no description anywhere. The description mentions no parameters at all, so it does not compensate for the undocumented limit or clarify pagination/capping behavior.

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 states a specific verb ('Search') and resource ('docs') and enumerates the doc categories covered (quickstart, auth, sandbox, OpenAPI, runtime skills). It does not explicitly contrast itself with the closely named siblings docs_get_resource and docs_list_topics, so differentiation is left to inference.

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

Usage Guidelines3/5

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

The phrase 'without installing the optional docs-only MCP server' implies when this tool is preferable (built-in alternative to an optional server), giving useful context. However, it never states when to use docs_search versus the sibling docs_get_resource or docs_list_topics, so usage is only implied.

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