Skip to main content
Glama

docs_search

Read-onlyIdempotent

Search the Total CMS documentation. Returns matching pages with their path, title, group, and section headings. Use docs_get with a returned path to read the full page.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum results (default 8, max 20)
queryYesSearch terms, e.g. "image resize twig" or "webhook automation"

Output Schema

NameRequiredDescriptionDefault
hintNoPresent when a search actually ran — guidance for the next call.
totalNoPresent when a search actually ran — total matches before the limit was applied.
messageNoPresent only when the query was too short (no token of 2+ characters). No `total`/`hint` alongside it.
resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds genuine value beyond them by naming the returned fields (path, title, group, section headings) and showing how results feed into docs_get.

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?

Three short sentences, front-loaded with the purpose and with zero redundant phrasing. The return fields and the next-step pointer each earn their place.

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?

This is a two-parameter read-only search tool with a full schema and an output schema, so the description does not need to explain return values, though it helpfully does anyway. The only omission is routing guidance against the remaining search siblings.

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%, with both query and limit documented including the default of 8 and maximum of 20. The description adds no parameter-level meaning beyond the schema, so this is the baseline 3 rather than higher.

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 ('Search the Total CMS documentation') and separates itself from docs_get by framing that tool as the follow-up for reading full pages. It does not distinguish itself from other search-like siblings such as docs_lookup or search, so it falls short of a 5.

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 description gives an explicit follow-up workflow: take a returned path and pass it to docs_get to read the full page. That is clear usage context, but there are no exclusions or guidance on when to prefer docs_lookup or other search siblings instead.

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.