Skip to main content
Glama

Search help docs

search_docs
Read-only

Search help center documentation by text or tag, with pagination, and return document slugs you can open via docs://{slug}.

Instructions

Search the help center docs. Returns slugs you can read via docs://{slug}.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "search_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
tagNoOnly return docs with this tag.
limitNoPage size.
queryNoText to look for in titles and bodies.
offsetNoHow many results to skip.

Output Schema

NameRequiredDescriptionDefault
itemsYes
limitYes
totalYesTotal matches before pagination.
offsetYes
next_offsetYesPass this as `offset` to get the next page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds the genuinely useful behavioral detail that results are slugs consumable via a docs://{slug} resource, but says nothing about result ordering, whether matching is substring or full-text, or paging behavior beyond what the schema already encodes.

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, front-loaded with the action and followed immediately by the return-value contract. Nothing is padded and no sentence could be removed without losing information.

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?

With a full schema, an output schema, and safety annotations, the description only needs to supply the connective tissue, and the docs://{slug} hint does that. The one soft spot is that it never clarifies whether docs:// is a resource or a tool the agent should call, which matters for actually using the returned slugs.

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

Parameters4/5

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

Schema coverage is 100%: tag, limit, offset and query each carry their own description and defaults. The description correctly stays out of the way rather than restating them, though it adds no extra meaning such as how query interacts with tag filtering.

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?

States a specific verb (search) and resource (help center docs) and even names what comes back (slugs). The only sibling, draft_support_ticket, is a different operation entirely, so there is no ambiguity for an agent to resolve.

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 the name and the 'read via docs://{slug}' follow-up, but the description never says when to search versus when not to, nor does it mention the sibling tool as a fallback when docs don't answer the question. Adequate but leaves routing to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools