Repository avatar
Search & Data Extraction
v0.1.0
active

qrguide

io.github.CloudCorpRecords/qrguide

Search Linkbreakers help docs and QR templates, and read current pricing.

Documentation

qrguide

The Linkbreakers help center, reachable from your own machine through one small bridge. qrguide is a local forwarding client for the hosted Linkbreakers docs MCP service: it answers tools/list locally from the captured tool definitions and forwards every lookup to Linkbreakers, returning the answers exactly as the service sends them back.

The surface is read-only documentation and catalogue reading: search the help center, guides, integrations and product news, search the public QR code design templates, open a help article in full, and read the currently published pricing plans. Nothing is cached, stored or computed locally — the package is a pipe, not a copy of the docs.

The tools

  • search_docs — Search the Linkbreakers help center, guides, integrations and product news, or the public QR code design templates. query is required (a natural-language question or keywords, 1–200 characters). source picks the corpus: "help" (the default) searches help articles, "qr_templates" searches the public QR code design templates. category optionally restricts help results to one of the twelve help center categories (overview, use-cases, dashboard, developer, legal, workflow, guides, alternatives, research, partnerships, integrations, news), and limit caps the ranked results (1–20, default 8). Each result carries its URL, Markdown URL and a snippet.
  • get_article — Return the full Markdown of a Linkbreakers help center article. slug is required: the last segment of the article's URL, https://linkbreakers.com/help/article/<slug> (lowercase letters, digits and hyphens).
  • get_pricing — Return the current Linkbreakers plans: prices in USD per month, plan limits, signup links, how to reach sales for Enterprise, and the features included in every plan with the help article that explains each. The optional billing_cycle ("yearly" or "monthly") prices the plans for one cycle; omit it to get both.

Install and run

As an MCP server via npm:

npx -y @reneturcios/qrguide mcp

MCP client configuration:

{
  "mcpServers": {
    "qrguide": {
      "command": "npx",
      "args": ["-y", "@reneturcios/qrguide", "mcp"]
    }
  }
}

As a container:

docker run -i ghcr.io/cloudcorprecords/qrguide
docker run --rm ghcr.io/cloudcorprecords/qrguide get_pricing '{}'

CLI

One binary serves both the command line and the MCP server. Each tool is a subcommand taking a single JSON string with that tool's arguments:

qrguide search_docs '{"query":"how do I create a QR code"}'
qrguide search_docs '{"query":"logo templates","source":"qr_templates","limit":5}'
qrguide get_article '{"slug":"creating-your-first-qr-code"}'
qrguide get_pricing '{"billing_cycle":"yearly"}'
qrguide --version

Exit codes: 0 when the forwarded call succeeds, 1 when the upstream result is an error, and 2 for usage problems such as an unknown subcommand or a malformed JSON argument.

Configuration

  • LINKBREAKERS_MCP_URL — Overrides the upstream endpoint. The default is the pinned hosted endpoint, https://linkbreakers.com/mcp. (The override variable is a reconstruction added by this rebuild.)

The Linkbreakers registry record declares no headers on its remote, so qrguide sends no authentication header of any kind — lookups are keyless.

Upstream failures — a JSON-RPC error from the service, a non-2xx response, an unreadable body, or a request that fails outright — are reported to the caller as an error result whose text starts with qrguide error:.

How forwarding works

The first forwarded call opens a session: an initialize request (protocol version 2025-03-26), followed by a notifications/initialized notification, then the tools/call itself. If the service answers the initialize request with an Mcp-Session-Id header, that value is carried on every later request, and the open session is reused for the rest of the process. Replies are accepted either as plain JSON or as server-sent events. Successful results pass through verbatim, including any isError flag and any extra fields the service includes.

Development

npm install
npm run build   # tsc -> dist/ (dist/cli.js is the bin)
npm test        # tsx --test test/*.test.ts — stubbed upstream, no network
npm run dev     # run the CLI from source

The test suite checks the served tool list against the captured surface, exercises the session handshake and its reuse, asserts that no Authorization header is sent under any environment, and verifies that arguments go upstream untouched and results come back untouched.

License

MIT — see LICENSE. Copyright (c) 2026 Rene Turcios.

NPM
@reneturcios/qrguide
Install Command
npm install @reneturcios/qrguide
Runtime: npx
OCI
ghcr.io/cloudcorprecords/qrguide:0.1.0
Install Command
docker pull ghcr.io/cloudcorprecords/qrguide:0.1.0:undefined
Runtime: docker