Skip to main content
Glama

Linkbreakers Docs

by com.linkbreakers
OverviewDiscussionsAdmin

Search Linkbreakers docs

search_docs
Read-only

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

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results
queryYesNatural language question or keywords
sourceNohelp searches help center articles; qr_templates searches public QR code design templateshelp
categoryNoRestrict help results to one help center category

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
+}
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations cover the safety profile (readOnlyHint=true, openWorldHint=false), so the bar is lower, and the description earns credit by disclosing the return shape: ranked results with URL, Markdown URL, and snippet. With no output schema present, this return-format disclosure is the main behavioral value-add; pagination/ranking behavior is still unspecified.

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 compact clauses with zero filler: the search scope is front-loaded and the get_article handoff closes it out. Every sentence carries load.

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?

For a 4-param read-only search tool with no output schema, the description covers scope, the source dimension, and the return shape, plus the alternative tool. It is complete enough to invoke correctly, with only minor gaps around result ranking/pagination and category semantics.

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 query, limit, source, and category are all already documented at the field level; baseline is 3. The description adds only a loose restatement of the source split (help catalog vs. public QR templates) and does not explain the category enum values, which would have added real value.

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?

Specific verb (Search) + resource (Linkbreakers help center, guides, integrations, news, or QR templates) with scope stated explicitly. It also distinguishes itself from the get_article sibling by naming it and defining the handoff, so an agent can route without opening either schema.

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?

The description explicitly routes the agent to get_article when a full help article is needed, which is genuine alternative guidance. It stops short of stating when NOT to use search (e.g., for pricing lookups covered by get_pricing) or exclusions around the two sources.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Linkbreakers Docs toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources