Skip to main content
Glama

search_developer_docs

Read-onlyIdempotent

Search the Bookatu developer docs: every REST endpoint, the webhooks and their events, the MCP servers and their tools, and the guides (authentication, CORS, rate limits). Returns the parts that match, closest first, with a short snippet, their place on /developers and the markdown copy.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "search_developer_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoOptional. How many results, 1 to 10. Default 5.
queryYesWhat you are looking for, e.g. "verify a webhook signature" or "POST /api/v1/{slug}/appointments".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare this is a safe, idempotent read with openWorldHint=false, so the description doesn't need to restate safety. It adds genuine value beyond that: results are ranked 'closest first' and each result carries a snippet, its /developers location, and a markdown copy. This tells the agent what it will get back, which is useful since there is no output schema. It doesn't discuss empty-result behavior or result-count semantics beyond the limit parameter.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with the scope and then the return behavior; no filler phrasing. The content enumeration is dense but each item earns its place by defining search coverage. Slightly long clause structure keeps it just under the top mark.

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 takes on the job of explaining return values — ranked matches with snippet, location, and markdown. For a two-parameter read-only search tool with full schema coverage and complete annotations, that covers what an agent needs to call it correctly. Only edge behaviors (zero results, ranking rationale) are absent.

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% — query and limit are both documented in the schema, including the 1–10 range and default of 5. The description adds no parameter meaning beyond that, so the baseline 3 is appropriate. It neither compensates for nor needs to compensate for any gap.

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 names a specific verb and resource ('Search the Bookatu developer docs') and enumerates the covered content: REST endpoints, webhooks and events, MCP servers and tools, and guides. That scope makes it clearly distinct from the blog/help search siblings without naming them. It stops short of explicitly contrasting the sibling tools, so a 4 rather than 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 Guidelines3/5

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

Usage is implied by the enumerated scope — an agent can infer this is the tool for API/webhook/guide questions rather than blog or help content. However, there is no explicit when-to-use or when-not statement and no alternative named. The schema's example queries ('verify a webhook signature', 'POST /api/v1/{slug}/appointments') help convey appropriate query shape, but guidance remains implicit.

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