Skip to main content
Glama

MariaDB Documentation

searchDocumentation

Read-onlyIdempotent

Search across the documentation to find relevant information, code examples, API references, and guides. Use this tool when you need to answer questions about MariaDB Documentation, find specific documentation, understand how features work, or locate implementation details. The search returns contextual content with titles and direct links to the documentation pages.

Input Schema

NameRequiredDescriptionDefault
queryYes

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, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is covered. The description adds genuinely new behavioral context by stating the return shape ('contextual content with titles and direct links to the documentation pages'), which the annotations do not convey.

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 sentences, each doing distinct work: what it searches, when to use it, and what it returns. The core capability is front-loaded and there is no 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?

With no output schema, the description correctly covers the return format and the call's purpose, which is what an agent needs to invoke it. It omits search behavior details (result limits, ranking, breadth of corpus) and query guidance, but nothing here would cause a mis-invocation.

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

Parameters2/5

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

There is one parameter, 'query', with 0% schema description coverage, so the description must carry the burden — and it adds nothing about query semantics (keyword vs. natural language, syntax, expected granularity). 'Find specific documentation' only loosely implies it is a search string, leaving the parameter effectively undocumented.

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+resource ('Search across the documentation') and enumerates the content types it reaches (code examples, API references, guides). It does not explicitly contrast itself with the sibling getPage, which is the natural alternative for retrieving a single known page, so it stops short of full sibling differentiation.

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?

It gives clear when-to-use triggers: answering questions about MariaDB Documentation, finding specific docs, understanding how features work, locating implementation details. There are no exclusions or named alternatives (e.g., 'to fetch a page you already have a link to, use getPage instead'), so it is context-rich but not routing-complete.

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