Skip to main content
Glama

Search the guide

search_guide
Read-onlyIdempotent

Search the guide's chapters, margin notes and events for a Databricks question. Returns the best sections first, each with a snippet, its URL with the section anchor, and when the page last changed. Read one in full with get_chapter (pass the URL, or the slug and the anchor).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNoOnly chapters, margin notes (dated news with our position), feature pages or events
limitNoHow many results (default 10)
queryYesThe question or topic in plain words, e.g. 'lakebase branch' or 'unity catalog row filters'

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindYes
buildYesThe commit of the deploy that answered
queryYes
totalYes
ttlMsYesHow long this answer may be kept before asking again, in milliseconds
resultsYes
index_builtYesWhen this deploy's index was built (ISO 8601)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so safety is covered. The description adds genuinely new behavior: results are ranked 'best sections first' and each carries a snippet, anchored URL and last-changed timestamp. It stops short of describing how ranking is derived or how snippets are truncated.

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, zero filler. The retrieval purpose and ranking behavior come first, with the hand-off to get_chapter placed last where a follow-up action belongs.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/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 restated, yet the description still conveys ranking order and field composition. Coverage of purpose, routing and result shape is sufficient for a three-parameter read-only search tool.

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%, so the enum for kind, the limit bounds/default and the query example are already documented. The description adds no syntax or format detail beyond the schema, which is the expected baseline when the schema does the work.

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 precise resource scope (the guide's chapters, margin notes and events), then enumerates what a result contains. The agent can distinguish this retrieval tool from list_chapters or get_chapter without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Frames the trigger ('for a Databricks question') and explicitly routes follow-up reading to the sibling get_chapter, including the two acceptable argument forms (URL, or slug+anchor). That is an explicit alternative with the condition that selects it.

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