---
title: "How Linkbreakers works with AI agents"
description: "Everything Linkbreakers exposes to AI agents: the hosted MCP server with OAuth and MCP Apps cards, the docs MCP, the stdio npm package, llms.txt, auth.md with agent self-registration, scoped API tokens, OpenAPI, SDKs, the CLI, sandboxes, agent skills, WebMCP, NLWeb and signed webhooks."
canonical: "https://linkbreakers.com/help/article/linkbreakers-for-ai-agents"
last-updated: 2026-10-11
---

# How Linkbreakers works with AI agents

> Everything Linkbreakers exposes to AI agents: the hosted MCP server with OAuth and MCP Apps cards, the docs MCP, the stdio npm package, llms.txt, auth.md with agent self-registration, scoped API tokens, OpenAPI, SDKs, the CLI, sandboxes, agent skills, WebMCP, NLWeb and signed webhooks.

## Short answer

An AI agent can use Linkbreakers the same way a developer does, without a person clicking through the dashboard. It can connect to the hosted MCP server at `https://mcp.linkbreakers.com`, call the REST API at `https://api.linkbreakers.com` with a scoped token, or drive the SDKs and the CLI. It can even register itself and get a workspace of its own through [auth.md](https://linkbreakers.com/auth.md). Every one of these surfaces is listed in machine-readable files (llms.txt, an OpenAPI description, an ARD catalog, MCP server cards), so an agent can find them on its own.

Linkbreakers is classified as Infrastructure and Developer Tools. The independent scanner ora rates linkbreakers.com A+ (98/100) for AI agent readiness; the [live score is on ora](https://ora.ai/score/linkbreakers.com).

## Quick summary

- **Operate a workspace:** the product MCP server, the REST API, the SDKs and the CLI all reach the same API
- **Read the docs:** the docs MCP server, llms.txt files and a markdown twin of every page, with no sign-in
- **Get credentials:** OAuth 2.1 for MCP clients, scoped workspace tokens for code, or anonymous self-registration for agents with nobody around
- **Test safely:** sandbox workspaces with `lb_test_` tokens, never billed
- **Receive events:** webhooks signed with HTTP Message Signatures, verifiable with public keys only

## What an agent can use

| Surface | What it is for | Where |
|---|---|---|
| Product MCP server | Create links, QR codes and workflows; read visitors and analytics | `https://mcp.linkbreakers.com` (OAuth 2.1) |
| Docs MCP server | Search and read the help center and developer docs | `https://linkbreakers.com/mcp` (no sign-in) |
| npm MCP package | The product MCP server over stdio, for clients that launch local commands | `npx -y linkbreakers-mcp` |
| REST API | Every Linkbreakers capability over HTTP | `https://api.linkbreakers.com` |
| OpenAPI | The API description an agent can generate calls from | [openapi.json](https://linkbreakers.com/openapi.json) |
| auth.md | Step-by-step credentials guide written for agents | [auth.md](https://linkbreakers.com/auth.md) |
| llms.txt | Curated index of the site for language models | [llms.txt](https://linkbreakers.com/llms.txt) |
| SDKs | Typed clients in TypeScript, Python, Go, Java and Rust | [SDK guides](#sdks-and-the-cli) |
| CLI | Shell access to the API for scripts and CI | `brew install linkbreakers-com/tap/linkbreakers` |
| Agent skills | Task playbooks for coding agents | [agent-skills](https://github.com/linkbreakers-com/agent-skills) |
| WebMCP | Tools registered on linkbreakers.com pages for in-browser agents | Any page of linkbreakers.com |
| NLWeb | Natural-language questions over the docs, answered as JSON | [/ask](https://linkbreakers.com/ask) |
| Signed webhooks | Real-time events your agent's backend can trust | [Signature keys](https://linkbreakers.com/.well-known/http-message-signatures-directory) |

## The product MCP server

The hosted MCP server at `https://mcp.linkbreakers.com` lets Claude, ChatGPT, Cursor, VS Code or any MCP client operate a Linkbreakers workspace: create tracked links and QR codes, build lead capture workflows, manage custom domains, and read visitors and analytics. Clients sign in with OAuth 2.1 (authorization code with PKCE and dynamic client registration), so nobody copies a token by hand. It is listed in the [official MCP registry](https://registry.modelcontextprotocol.io/v0/servers/com.linkbreakers%2Fmcp/versions/latest) and describes itself in a [server card](https://linkbreakers.com/.well-known/mcp/product/server-card.json).

Tool results can render as interactive cards inside the conversation through MCP Apps: Link card, Visitors and Workspace metrics. See [MCP Apps: interactive UI](/help/article/mcp-apps-interactive-ui).

Clients that only launch local commands can run the same server over stdio with the npm package `linkbreakers-mcp`:

```bash
npx -y linkbreakers-mcp
```

Setup for each client is in the [MCP server setup guide](/help/article/mcp-server-setup).

## The docs MCP server and llms.txt

The docs MCP server at `https://linkbreakers.com/mcp` needs no sign-in. It searches and reads the help center, so an agent can answer a question about Linkbreakers from the source instead of from memory.

For agents that read plain files, the documentation is published as:

- [llms.txt](https://linkbreakers.com/llms.txt): a curated index of the whole site
- [Help center llms.txt](https://linkbreakers.com/help/llms.txt) and [API llms.txt](https://linkbreakers.com/api/llms.txt): focused section indexes
- [llms-full.txt](https://linkbreakers.com/llms-full.txt): the full text of every help article
- A markdown twin of every page: append `.md` to a help article URL, or send `Accept: text/markdown`
- The [agent view](https://linkbreakers.com/?mode=agent): APIs, authentication, MCP servers, SDKs, the CLI and skills on one page

Catalogs list the same resources for crawlers and registries: the [ARD catalog](https://linkbreakers.com/.well-known/ard.json), its [AI Catalog](https://linkbreakers.com/.well-known/ai-catalog.json) alias and the RFC 9727 [API catalog](https://linkbreakers.com/.well-known/api-catalog).

## Credentials: auth.md, OAuth and scoped tokens

[auth.md](https://linkbreakers.com/auth.md) walks an agent through getting credentials, in order. There are three ways:

1. **A workspace API token** a person creates in the dashboard and hands over. Give it only the [scopes](/help/article/api-token-scopes) the job needs, such as `links:read` or `visitors:read`, so a leaked token cannot do more.
2. **OAuth 2.1** for MCP clients, handled by the client when the person signs in.
3. **Anonymous self-registration**, for an agent with nobody around: one request returns a free workspace and a token right away. A person can claim the workspace later with a 6-digit code; an unclaimed one is removed after 24 hours.

A call outside a token's scopes answers `403` with the missing scope, so an agent can tell the person exactly what to grant.

## The REST API and OpenAPI

The [REST API](https://linkbreakers.com/developers) at `https://api.linkbreakers.com` covers links, QR codes, workflow steps, visitors, events, analytics, webhooks and custom domains. Its [OpenAPI description](https://linkbreakers.com/openapi.json) declares the scope each endpoint needs, which endpoints need no authentication, and the bulk endpoints. Start with [How to use the Linkbreakers API](/help/article/how-to-use-the-linkbreakers-api).

## SDKs and the CLI

Official SDKs wrap the same API:

- TypeScript: `npm install linkbreakers` ([guide](https://linkbreakers.com/sdk/typescript))
- Python: `pip install linkbreakers` ([guide](https://linkbreakers.com/sdk/python))
- Go: `go get github.com/linkbreakers-com/linkbreakers-go` ([guide](https://linkbreakers.com/sdk/go))
- Java: `com.linkbreakers:linkbreakers-sdk` ([guide](https://linkbreakers.com/sdk/java))
- Rust: `cargo add linkbreakers` ([guide](https://linkbreakers.com/sdk/rust))

The CLI installs with Homebrew (`brew install linkbreakers-com/tap/linkbreakers`), npm (`npm install -g linkbreakers-cli`) or a script. Its latest release is 1.164.0. See [Linkbreakers CLI setup](/help/article/linkbreakers-cli-setup).

## Sandbox workspaces

A [sandbox](/help/article/sandbox-test-environment) is a separate test workspace reached with a `lb_test_` token. Create one with `POST https://api.linkbreakers.com/v1/sandboxes`. It works with the API, the SDKs, the CLI and the MCP server, is never billed, and is deleted after 30 days. Point an agent at a sandbox while you build, then switch the token.

## Agent skills

The [agent-skills repository](https://github.com/linkbreakers-com/agent-skills) holds playbooks that teach coding agents common Linkbreakers tasks. Install them with `npx skills add linkbreakers-com/agent-skills`, or read them from the [skills index](https://linkbreakers.com/.well-known/agent-skills/index.json):

- [build-lead-capture-workflow](https://linkbreakers.com/.well-known/agent-skills/build-lead-capture-workflow/SKILL.md)
- [connect-linkbreakers-mcp](https://linkbreakers.com/.well-known/agent-skills/connect-linkbreakers-mcp/SKILL.md)
- [create-tracked-qr-code](https://linkbreakers.com/.well-known/agent-skills/create-tracked-qr-code/SKILL.md)
- [identify-visitors-on-your-site](https://linkbreakers.com/.well-known/agent-skills/identify-visitors-on-your-site/SKILL.md)
- [manage-custom-domains](https://linkbreakers.com/.well-known/agent-skills/manage-custom-domains/SKILL.md)
- [read-visitors-and-leads](https://linkbreakers.com/.well-known/agent-skills/read-visitors-and-leads/SKILL.md)
- [send-leads-to-webhooks](https://linkbreakers.com/.well-known/agent-skills/send-leads-to-webhooks/SKILL.md)
- [use-linkbreakers-cli](https://linkbreakers.com/.well-known/agent-skills/use-linkbreakers-cli/SKILL.md)

## WebMCP and NLWeb on linkbreakers.com

Pages on linkbreakers.com register WebMCP tools, so an agent running in the browser can search the docs, read an article, check pricing, open the signup or preview a QR code without scraping the page.

The [/ask](https://linkbreakers.com/ask) endpoint answers natural-language questions about Linkbreakers with NLWeb: send `GET /ask?query=...` or a JSON body and get ranked results back as JSON.

## Signed webhooks

When something happens in a workspace, such as a scan or a form submission, Linkbreakers can call your endpoint with a webhook. Every webhook is signed with HTTP Message Signatures (RFC 9421) using Ed25519 keys published at [the signatures directory](https://linkbreakers.com/.well-known/http-message-signatures-directory). An agent's backend checks the signature with public keys only, with no shared secret to store. See [Verify Linkbreakers webhook signatures](/help/article/verify-webhook-signatures).

## Limits and caveats

- An agent acts with the permissions of its token. Scoped tokens limit what it can reach; they do not limit how much it does within those scopes
- API calls count toward the workspace plan; sandbox workspaces have their own monthly caps
- A self-registered workspace is on the free plan and disappears after 24 hours unless a person claims it
- The ora rating is computed by ora, not by Linkbreakers, and changes when ora rescans the site

## Frequently asked questions

### Can an AI agent use Linkbreakers without a person?

Yes. Anonymous self-registration in [auth.md](https://linkbreakers.com/auth.md) gives an agent a free workspace and a token with one request. A person can claim the workspace later.

### Which should an agent use: the MCP server, the API or an SDK?

Use the MCP server when the agent is an MCP client such as Claude or Cursor. Use the REST API or an SDK when the agent writes and runs code. Both reach the same capabilities.

### Does the docs MCP server need an account?

No. The docs MCP server at `https://linkbreakers.com/mcp` is open and read-only.

### How do I keep an agent from changing live data while I test?

Give it a sandbox token (`lb_test_`). Everything it creates stays in the sandbox and is deleted after 30 days.

### How is Linkbreakers rated for AI agent readiness?

ora rates linkbreakers.com A+ for AI agent readiness. The [score page on ora](https://ora.ai/score/linkbreakers.com) shows the current result and every check.

## Related guides

- [MCP server setup](/help/article/mcp-server-setup)
- [MCP Apps: interactive UI](/help/article/mcp-apps-interactive-ui)
- [How to use the Linkbreakers API](/help/article/how-to-use-the-linkbreakers-api)
- [API token scopes](/help/article/api-token-scopes)
- [Developer ecosystem overview](/help/article/linkbreakers-developer-ecosystem-overview)
- [Linkbreakers CLI setup](/help/article/linkbreakers-cli-setup)
- [TypeScript SDK quickstart](/help/article/typescript-sdk-quickstart), [Python](/help/article/python-sdk-quickstart), [Go](/help/article/golang-sdk-quickstart), [Java](/help/article/java-sdk-quickstart), [Rust](/help/article/rust-sdk-quickstart)
- [Sandbox test environment](/help/article/sandbox-test-environment)
- [Verify webhook signatures](/help/article/verify-webhook-signatures)

## Last reviewed

2026-10-11