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

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

NameRequiredDescriptionDefault
kindYes
nextNoWhen this is about a concept the guide explains interactively: the call for a step-by-step walkthrough
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. Changed1 schema field changed
    • addedOutput schema / properties / next
      Added value: +{
      +  "description": "When this is about a concept the guide explains interactively: the call for a step-by-step walkthrough",
      +  "properties": {
      +    "arguments": {
      +      "type": "object"
      +    },
      +    "hint": {
      +      "type": "string"
      +    },
      +    "tool": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "tool",
      +    "arguments",
      +    "hint"
      +  ],
      +  "type": [
      +    "object",
      +    "null"
      +  ]
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/closed-world, so the bar is lower. The description still adds real value by disclosing result ordering ('best sections first') and the shape of each hit (snippet, anchored URL, last-changed date).

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 tight sentences, front-loaded with what is searched, followed by what comes back, followed by the next action. No filler or repetition of the title.

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?

For a 3-parameter read-only search with a full schema, annotations, and an output schema, the description covers purpose, result shape, and the follow-up path to get_chapter. Nothing an agent needs to invoke it correctly is missing.

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 schema already documents query, kind, and limit with an example and defaults; baseline 3 applies. The description adds only the implicit note that results are relevance-ranked, nothing about the kind filter or limit semantics.

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 (the guide's chapters, margin notes, events) plus the domain constraint (a Databricks question). It also names the sibling handoff (get_chapter) so an agent can distinguish searching from reading.

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?

Makes the trigger clear — searching for a Databricks question — and explicitly routes the follow-up step to get_chapter with the URL or slug+anchor. It does not say when to prefer list_chapters or explore_concept instead, so exclusions are absent.

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.