Skip to main content
Glama

Linkbreakers Docs

Search Linkbreakers docs

search_docs
Read-only

Search the Linkbreakers help center, guides, integrations and product news, the public QR code design templates or the public page theme templates. Returns ranked results with their URL, Markdown URL and a snippet; read a help article in full with get_article.

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_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results
queryYesNatural language question or keywords
sourceNohelp searches help center articles; qr_templates searches public QR code design templates; page_themes searches public page theme templates (styling for forms, chat bots and other visitor pages)help
categoryNoRestrict help results to one help center category

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / source / description
      Previous value: -"help searches help center articles; qr_templates searches public QR code design templates"New value: +"help searches help center articles; qr_templates searches public QR code design templates; page_themes searches public page theme templates (styling for forms, chat bots and other visitor pages)"
    • changedInput schema / properties / source / enum
      Previous value: -[
      -  "help",
      -  "qr_templates"
      -]New value: +[
      +  "help",
      +  "qr_templates",
      +  "page_themes"
      +]
  2. Changed2 schema fields changed
    • changedInput schema / properties / category / description
      Previous value: -"Restrict results to one help center category"New value: +"Restrict help results to one help center category"
    • addedInput schema / properties / source
      Added value: +{
      +  "default": "help",
      +  "description": "help searches help center articles; qr_templates searches public QR code design templates",
      +  "enum": [
      +    "help",
      +    "qr_templates"
      +  ],
      +  "type": "string"
      +}
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

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

The description adds useful behavioral context beyond the readOnly and openWorld annotations by explaining that results are ranked and include URL, Markdown URL, and snippet. It does not describe pagination or rate limits, but with annotations already covering safety and openness, the added return-format detail is substantive.

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?

The description is two tightly written sentences with no wasted language. It front-loads the search scope and follows with the return format and the relevant sibling handoff.

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?

Although there is no output schema, the description explains the return fields and ranked-result behavior, which is the main missing structured information. Combined with complete schema coverage and safety annotations, an agent has enough context to invoke the tool correctly.

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 query, limit, source, and category parameters are already well documented in the input schema. The description largely restates the available source areas and does not add meaningfully new semantics for individual parameters, so the baseline 3 is appropriate.

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?

The description uses a specific verb (Search) and names the exact resources covered: help center, guides, integrations, product news, QR templates, and page themes. It also distinguishes the result type from the sibling get_article by saying search returns ranked results while get_article reads an article in full.

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 clearly indicates this tool is for searching and explicitly names get_article as the alternative for reading a help article in full. However, it does not spell out when to choose each source or when not to use this tool, leaving some routing detail to the schema.

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