Skip to main content
Glama

GoVisit MCP

Search documentation

search_documentation
Read-only

Search the published documentation links currently rendered on this GoVisit page and return bounded canonical links and titles.

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": {
      "pagePath": "<pagePath>"
    },
    "name": "search_documentation"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results to return.
queryNoOptional documentation title or path text to match.
pagePathYesCanonical GoVisit page path supplying this tool's published context; no origin, query or fragment.

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds real context beyond them: results are limited to documentation links 'currently rendered' on the page, implying a partial, view-scoped result set rather than an index search, and that output is bounded.

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?

A single front-loaded sentence with the scoping constraint and return shape packed in, and no filler. Nothing could be removed without losing meaning.

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?

An output schema exists, so return values need not be explained, and all three parameters are documented. The remaining gap is what happens when query is omitted and how results are ordered, but overall the definition is sufficient for correct invocation.

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 coverage is 100%, so pagePath, query, and the 1–20 limit are already fully documented. The description adds no format or behavioral detail about the parameters, so it meets but does not exceed the baseline for full-coverage schemas.

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 (published documentation links) and scopes it to what is 'currently rendered on this GoVisit page', which is meaningfully narrower than a corpus-wide search. It also names the return shape (canonical links and titles). It stops short of naming the sibling get_documentation_page, so the distinction must be inferred.

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?

Usage is implied by 'currently rendered on this GoVisit page' and by the optional title/path match, but there is no explicit when-to-use or when-not-to-use statement. An agent must infer that this searches rendered doc links rather than fetching a documentation page, which is a likely point of confusion with get_documentation_page.

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