Skip to main content
Glama

ref_search_documentation

Read-only

Search for documentation on the web or github as well from private resources like repos and pdfs. Use Ref 'ref_read_url' to read the content of a url.

Input Schema

NameRequiredDescriptionDefault
queryYesQuery for documentation. Should include programming language and framework or library names. Searches public only docs by default, include ref_src=private to search a user's private docs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedInput schema / additionalProperties
      Removed value: -false
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes this is a safe read. The description adds useful context about source coverage (web, GitHub, private repos, PDFs), but it does not mention pagination, result limits, or whether private results require authentication—details the schema only hints at via ref_src=private.

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?

It is two short sentences and front-loads the search purpose before the sibling pointer. However, the phrasing "as well from private resources" is awkward and the second sentence is loosely worded ("Use Ref 'ref_read_url' to read the content of a url"), which slightly weakens scanability.

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 tool with no output schema and a fully documented schema, the description covers the essentials: what is searched and where to go next. The main remaining gap is expected result shape or how many results come back, which the absent output schema leaves unaddressed.

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, and the schema already documents the public-by-default / ref_src=private behavior. The description repeats the same public/private split at a higher level without adding query syntax or formatting guidance, 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 names a specific verb and resource ("Search for documentation") and enumerates the source types it covers: web, GitHub, private repos, and PDFs. That is enough to distinguish it from the sibling ref_read_url, which is described as a content reader rather than a search.

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?

The second sentence explicitly routes the agent to the sibling tool for fetching a URL's contents, which is clear alternative-tool guidance. It does not state exclusions or when search is a bad choice, so it falls 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.