Skip to main content
Glama

Search docs

search_docs
Read-onlyIdempotent

Searches Twelfth product documentation for pages, controls and settings. Returns matching sections and links; an empty result means no matching section was found.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum sections to return (1–10).
queryYesThe user's question in their own words. Plain language beats product jargon; the corpus is written the way a customer would ask.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNoPresent when nothing matched.
queryYes
sectionsYes
truncatedYes
returned_rowsYes
total_matching_rowsYes

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 establish read-only, idempotent, closed-world, non-destructive behavior, so the bar is lower. The description earns credit by adding the empty-result contract and the fact that it returns matching sections plus links rather than full content, which is meaningful behavior beyond the 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 tightly packed sentences; the purpose and the return/empty-result contract are front-loaded with zero 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?

An output schema exists, so return values need not be spelled out, and the description still sketches them usefully. The one gap is routing relative to read_document and search_catalogue, which matters for correct tool selection in this crowded sibling set.

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 both parameters (query, limit) are already fully documented, including the plain-language guidance and the 1-10 bound. The description adds no parameter-level meaning beyond the schema, so the baseline 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?

States a specific verb and resource (searches Twelfth product documentation for pages, controls and settings), which is clear and actionable. However, it never distinguishes itself from the sibling read_document or search_catalogue, so an agent must infer which search surface applies.

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 only implied: the description tells you the corpus is product documentation pages/controls/settings, and that an empty result means nothing matched. It gives no explicit when-to-use, prerequisites, or routing to read_document for pulling the full page behind a returned link.

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