---
title: "How to set up and configure the Linkbreakers MCP server"
description: "Complete guide to installing, configuring, and using the Linkbreakers Model Context Protocol (MCP) server to connect AI assistants like Claude to your Linkbreakers workspace."
canonical: "https://linkbreakers.com/help/article/mcp-server-setup"
last-updated: 2026-10-11
---

# How to set up and configure the Linkbreakers MCP server

> Complete guide to installing, configuring, and using the Linkbreakers Model Context Protocol (MCP) server to connect AI assistants like Claude to your Linkbreakers workspace.

## Short answer

The Linkbreakers MCP server enables AI assistants (like Claude, Claude Code, Continue, and other MCP-compatible tools) to interact with your Linkbreakers workspace using natural language. It acts as a bridge between MCP clients and the Linkbreakers REST API, allowing AI to create links, analyze data, manage workflows, and more.

<div class="my-8 rounded-2xl bg-primary p-5 shadow-sm text-white one-liner-install">
  <p class="text-xs font-semibold uppercase tracking-[0.2em] text-white/80">One-line install</p>
  <p class="mt-2 text-sm text-white/90">Linkbreakers’ step-by-step setup makes it easy to add the MCP server in seconds. Uses OAuth by default for seamless sign-in.</p>
  <div class="mt-3 rounded-xl bg-white px-4 py-3 text-primary">
    <div class="flex items-center gap-3">
      <div class="flex-1 font-mono text-sm overflow-x-auto" data-install-command>curl -fsSL https://mcp.linkbreakers.com/install.sh | bash</div>
      <button
        class="shrink-0 inline-flex items-center justify-center rounded-lg bg-primary/10 p-2 text-primary transition hover:bg-primary/20"
        onclick="
          const code = this.closest('.one-liner-install').querySelector('[data-install-command]').textContent.trim();
          navigator.clipboard.writeText(code).then(() => {
            const original = this.innerHTML;
            this.innerHTML = '<svg class=\'w-4 h-4\' fill=\'none\' stroke=\'currentColor\' viewBox=\'0 0 24 24\'><path stroke-linecap=\'round\' stroke-linejoin=\'round\' stroke-width=\'2\' d=\'M5 13l4 4L19 7\'></path></svg>';
            setTimeout(() => { this.innerHTML = original; }, 2000);
          }).catch(() => {});
        "
        title="Copy installer command"
        aria-label="Copy installer command"
      >
        <svg class="w-4 h-4" fill="none" stroke="currentColor" viewBox="0 0 24 24">
          <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path>
        </svg>
      </button>
    </div>
  </div>
</div>

## Quick summary

- MCP (Model Context Protocol) is an open standard that lets AI assistants connect to external tools and data
- The Linkbreakers MCP server runs at **https://mcp.linkbreakers.com**
- Setup takes **under 5 minutes** - just add the server URL and sign in with your Linkbreakers account via OAuth
- No installation required - use the hosted server
- Supports **35+ curated operations** across links, workflows, analytics, QR codes, and more

## What is MCP and why use it?

Model Context Protocol (MCP) is an open protocol developed by Anthropic that standardizes how AI assistants connect to external data sources and tools. Instead of manually calling APIs or copying data, you can simply ask your AI assistant to:

> "Create a shortened link for https://example.com with the slug 'demo'"

> "Show me my workspace analytics for the last 30 days"

> "List all links created this week"

> "Generate a QR code for my latest campaign"

The MCP server translates these natural language requests into Linkbreakers API calls, handles authentication, and returns results in a format AI assistants understand.

### Benefits

- **Natural language interface** - No need to write API calls manually
- **Faster workflows** - Ask questions and get answers instantly
- **Automated tasks** - AI can execute multi-step operations
- **No code required** - Non-technical users can access data programmatically

## Prerequisites

Before you begin, you'll need:

1. **A Linkbreakers account** (Google sign-in or email/password)
2. An MCP-compatible client such as: Claude (web/desktop app via Connectors), Claude Code (CLI), Continue (VSCode extension), or any other MCP-compatible assistant

## Authentication

The MCP server uses **OAuth** for authentication. When you add the server URL to your MCP client, it will open a browser window where you sign in with your Linkbreakers account (Google or email/password). Tokens are issued and refreshed automatically, with no manual token management required.

If your account belongs to several workspaces, the consent screen asks which workspace the client should use. The client then acts in that workspace with your role there; to use another workspace, authorize the client again. A workspace that enforces MFA asks for the 6-digit code sent to your email on the consent screen. See [Working across multiple workspaces](/help/article/work-across-multiple-workspaces).

## Configure your MCP client

Configuration varies by client. Choose your AI assistant below:

### Claude (web and desktop app via Connectors)

Use Claude's custom connector UI for remote MCP servers like Linkbreakers.

1. Open Claude Settings and go to **Connectors**
2. Click **Add custom connector**
3. Enter:
   - **Name**: `linkbreakers`
   - **Server URL**: `https://mcp.linkbreakers.com`
4. Save -- Claude will open a browser window for you to sign in with your Linkbreakers account
5. Once authenticated, reconnect if prompted

No Authorization header is needed. OAuth handles authentication automatically.

Reference docs:
- [Get started with custom connectors using remote MCP](https://support.claude.com/en/articles/11175166-getting-started-with-custom-connectors-using-remote-mcp)
- [Build custom connectors via remote MCP servers](https://support.claude.com/en/articles/11503834-building-custom-connectors-via-remote-mcp-servers)

### Claude Code (CLI)

Use the Claude CLI to add the MCP server (don't edit `~/.claude.json` manually). This writes the config for you.

1. Add the Linkbreakers MCP server:

```bash
claude mcp add --transport http linkbreakers https://mcp.linkbreakers.com
```

2. Restart Claude Code -- a browser window will open for you to sign in with your Linkbreakers account on first use

Reference docs:
- [Claude Code MCP docs](https://code.claude.com/docs/en/mcp)

### Continue (VSCode)

1. Open VSCode and install the [Continue extension](https://marketplace.visualstudio.com/items?itemName=Continue.continue)

2. Configure MCP in either:
   - `~/.continue/config.yaml`, or
   - `~/.continue/mcpServers/*.yaml` (recommended for per-server files)

3. Add the MCP server configuration:

```yaml
mcpServers:
  - name: linkbreakers
    transport:
      type: streamable-http
      url: https://mcp.linkbreakers.com
```

4. Restart VSCode -- Continue will handle OAuth sign-in automatically

Reference docs:
- [Continue MCP deep dive](https://docs.continue.dev/customize/deep-dives/mcp)
- [Continue configuration deep dive](https://docs.continue.dev/customize/deep-dives/configuration)

### Other MCP clients

For other MCP-compatible clients, add these connection details:

- **Server URL**: `https://mcp.linkbreakers.com`
- **Authentication**: OAuth (automatic) -- your client will open a browser for sign-in
- **Protocol**: MCP over HTTP/JSON

All MCP clients handle OAuth authentication automatically. Refer to your client's documentation for specific configuration steps.

## Test the connection

After configuration, verify the MCP server is working:

### In Claude (web or desktop app)

1. Start a new conversation
2. Ask: "List my links from Linkbreakers"
3. Confirm Claude uses a Linkbreakers tool such as:
   - `links_create`
   - `links_list`
   - `metrics_workspace`
   - `events_list`

If configured correctly, Claude should use `links_list` and return your workspace links.

### In Continue

1. Open the Continue sidebar in VSCode
2. Check the MCP tools list
3. Test with a prompt: "Show me my Linkbreakers workspace analytics"

### Troubleshooting connection issues

If tools don't appear:

1. **Browser didn't open** - Some clients require a default browser to be set. Check your OS settings and try again
2. **OAuth sign-in failed** - Make sure you are signing in with the same account that owns the workspace. Try signing out of Linkbreakers in your browser first, then reconnect
3. **Session expired** - OAuth tokens auto-refresh, but if your session has been revoked, remove and re-add the MCP server to trigger a fresh sign-in
4. **Restart your client completely** - Some clients need a full restart after authentication
5. **Check logs** - Your MCP client may show connection errors in logs
6. **Check your client's MCP support** - Ensure your client supports the MCP protocol and OAuth authentication

## Available MCP tools

The Linkbreakers MCP server exposes these curated operations:

### Links management
- `links_create` - Create new shortened links
- `links_list` - List all links with filtering options
- `links_get` - Get details of a specific link
- `links_update` - Update link metadata and settings
- `links_delete` - Delete a link

### Workflow steps
- `workflow_steps_list` - List workflow steps for a link
- `workflow_steps_get` - Get workflow step details
- `workflow_steps_delete` - Delete a workflow step
- `workflow_steps_create_relationship` - Connect workflow steps

### Analytics and metrics
- `events_list` - Retrieve event timeline and activity
- `metrics_workspace` - Get workspace-level statistics

### QR code designs
- `qrcodedesigns_create` - Create a QR code design

### QR code templates
- `qrtemplates_list` - List QR code templates
- `qrtemplates_get` - Get QR code template details
- `qrtemplates_create` - Create a QR code template
- `qrtemplates_delete` - Delete a QR code template

### Media
- `media_create` - Upload media assets
- `media_list` - List media assets
- `media_get` - Get media details
- `media_delete` - Delete a media asset

### Visitors
- `visitors_list` - List visitors, filtered by the attributes they gave (for example budget at least 800000) or by link
- `visitors_get` - Get visitor details
- `visitors_list_attribute_keys` - List visitor attribute keys and their types

### Custom domains
- `domains_create` - Add custom domains
- `domains_list` - List custom domains
- `domains_get` - Get domain details
- `domains_check` - Verify DNS and TLS status

### Tags
- `tags_list` - Search and list tags

## Interactive results (MCP Apps)

In clients that support [MCP Apps](/help/article/mcp-apps-interactive-ui), such as Claude and ChatGPT, some tools answer with an interactive card in the conversation instead of raw JSON:

- `links_create` and `links_get` show a link card: the QR code, short link, destination and scan count, with buttons to the analytics and the QR design
- `visitors_list` shows the visitors with their visits, QR codes, devices and attributes
- `metrics_workspace` shows workspace totals and credit usage

Clients without MCP Apps support get the same data as text.

## Test without touching live data

Connect the MCP server with a [sandbox](/help/article/sandbox-test-environment) token (it starts with `lb_test_`) instead of a live one. Every tool then acts on a separate, empty workspace that is never billed and is deleted after 30 days.

## Example use cases

### Create a link with AI

**Prompt:**
> "Create a shortened link for https://example.com/products with the slug 'spring-sale' and add the tag 'marketing'"

**What happens:**
1. AI calls `links_create` tool with parameters
2. MCP server proxies request to Linkbreakers API
3. Link is created and short URL is returned
4. AI formats the response for you

### Analyze campaign performance

**Prompt:**
> "Show me the click metrics for all links tagged 'marketing' in the last 30 days"

**What happens:**
1. AI calls `links_list` with filters
2. AI calls `events_list` for click data
3. AI aggregates and analyzes the data
4. AI presents insights and trends

### Automate workflow creation

**Prompt:**
> "Create a workflow for my newsletter link with a password gate, then redirect to a form, then to the content URL"

**What happens:**
1. AI calls `links_create` for base link
2. AI calls `workflowsteps_create` for each step
3. AI calls `workflowsteps_createrelationship` to connect them
4. Fully configured workflow is ready to use

## Best practices

### Token management
- **OAuth tokens auto-refresh** — no manual rotation needed
- Each user signs in with their own Linkbreakers account, so sessions are isolated per user
- If a session seems stale, remove and re-add the MCP server to trigger a fresh OAuth sign-in

### AI prompts
- **Be specific** - "Create a link for X with slug Y" works better than "Make a link"
- **Include context** - "Show analytics for the marketing campaign" is clearer than "Show stats"
- **Use filters** - "List links created this week" vs "List links" returns focused results
- **Ask follow-ups** - AI can chain multiple operations based on responses

### Rate limiting
- The MCP server inherits **standard Linkbreakers API rate limits**
- Workspace tokens typically have **higher limits** than member tokens
- If you hit rate limits, **contact support** for increased quotas
- Consider **batching requests** in off-peak hours for large operations

### Error handling
- If a tool fails, AI will **explain the error** and may suggest fixes
- Common errors include:
  - **Invalid parameters** - Check parameter format and required fields
  - **Authentication failed** - Token may be expired or revoked
  - **Resource not found** - ID may be incorrect or deleted
  - **Rate limit exceeded** - Wait before retrying

## Architecture

The MCP server works as a stateless protocol translator:

```mermaid
flowchart TD
    A["AI Assistant<br/>(MCP Client)<br/>Claude, Claude Code, Continue, etc."] -->|"MCP Protocol (HTTP/JSON)<br/>OAuth 2.0"| B["MCP Server<br/>mcp.linkbreakers.com<br/>Converts MCP to REST<br/>Forwards OAuth session"]
    B -->|"REST API (HTTP/JSON)<br/>Bearer Token (forwarded)"| C["Linkbreakers API<br/>api.linkbreakers.com<br/>Validates token<br/>Processes request"]
```

**Key characteristics:**
- **Stateless** - No database or caching required
- **Secure** - All authentication handled by main API
- **Simple** - Direct token pass-through, no validation needed
- **Fast** - Minimal overhead, direct API proxy

## Registry listing and agent skills

The server is published in the official MCP registry as [`com.linkbreakers/mcp`](https://registry.modelcontextprotocol.io/v0/servers?search=com.linkbreakers/mcp), so MCP clients that browse the registry can find it by name. Its server card is served at [linkbreakers.com/.well-known/mcp/server-card.json](https://linkbreakers.com/.well-known/mcp/server-card.json).

Skills that teach coding agents how to use Linkbreakers live in the public [agent-skills repository](https://github.com/linkbreakers-com/agent-skills), indexed at [linkbreakers.com/.well-known/agent-skills/index.json](https://linkbreakers.com/.well-known/agent-skills/index.json). For credentials, agents can read [auth.md](https://linkbreakers.com/auth.md). Every other surface an agent can use is listed in [How Linkbreakers works with AI agents](/help/article/linkbreakers-for-ai-agents).

## Frequently asked questions

### Is the MCP server free to use?

Yes, the MCP server at https://mcp.linkbreakers.com is provided free to all Linkbreakers users. Standard API rate limits apply based on your workspace plan.

### How does authentication work?

The MCP server uses **OAuth** for authentication. When you add the server URL, your MCP client opens a browser for you to sign in with your Linkbreakers account. Tokens are issued and refreshed automatically — no manual token configuration required.

### What if my account is compromised?

If you suspect unauthorized access:
1. Sign out of all sessions from **Settings → Security** in Linkbreakers
2. Change your password (or revoke Google sign-in access and re-link)
3. Remove and re-add the MCP server in your client to start a fresh OAuth session

Revoking sessions invalidates all existing OAuth tokens immediately.

### Can multiple team members use the same MCP server?

Yes. Each team member signs in with their own Linkbreakers account via OAuth, so every user gets their own session. This provides:
- Better audit trails (know who made which changes)
- Independent sessions (revoking one user's access does not affect others)
- No shared secrets to manage

### Does the MCP server store my data?

No. The MCP server is **stateless** and doesn't store any data. It:
- Receives your request
- Forwards it to Linkbreakers API with your token
- Returns the API response
- Keeps no logs or records of the data

All data storage and processing happens in the main Linkbreakers API.

### What MCP clients are supported?

Any MCP-compatible client works, including:
- Claude (web or desktop app via Connectors)
- Claude Code (official Anthropic CLI)
- Continue (VSCode extension)
- Custom MCP clients following the MCP specification

### Can I use this with the Linkbreakers mobile app?

The MCP server is designed for desktop AI assistants, not mobile apps. Use the standard Linkbreakers API or mobile app for mobile access.

### How do I report bugs or request features?

For MCP server issues:
- Email: support@linkbreakers.com
- Include: Client type, error message, steps to reproduce

For feature requests:
- Contact support with your use case
- Describe which API endpoints you need exposed