Shlink

FreeNot checked

Enables AI assistants to interact with a Shlink URL shortening instance, allowing creation, listing, retrieval, and deletion of short URLs, as well as tag manag

by magnus919

GitHub Embed

About

Enables AI assistants to interact with a Shlink URL shortening instance, allowing creation, listing, retrieval, and deletion of short URLs, as well as tag management.

README

PyPI version Python versions License CI

A Model Context Protocol (MCP) server for Shlink link shortening service. This server exposes Shlink's URL shortening, management, and tagging capabilities as MCP tools for AI assistants.

Features

Create shortened URLs with custom slugs, tags, and expiration
List all shortened URLs with pagination info
Get details of specific URLs by short code
Delete shortened URLs
List and manage tags
Full type safety with Pydantic models
Built with the official MCP Python SDK

Requirements

Python >= 3.10
A Shlink instance with API access

Installation

pip install mcp-shlink

Configuration

Set these environment variables before running the server:

Variable	Description	Required
`SHLINK_BASE_URL`	Your Shlink instance base URL (e.g., `https://shlink.example.com`)	Yes
`SHLINK_API_KEY`	Your Shlink API key	Yes

Generate an API key in Shlink:

shlink api-key:generate --name=my_api_key

Usage

Running as a standalone MCP server

SHLINK_BASE_URL=https://shlink.example.com SHLINK_API_KEY=your-key python -m mcp_shlink.server

Installing into Claude Desktop

uv run mcp install src/mcp_shlink/server.py --name "shlink"

Running with MCP Inspector

SHLINK_BASE_URL=https://shlink.example.com SHLINK_API_KEY=your-key uv run mcp dev src/mcp_shlink/server.py

Available Tools

Tool	Description
`create_short_url`	Create a new shortened URL
`list_short_urls`	List all shortened URLs
`get_short_url`	Get details of a URL by short code
`delete_short_url`	Delete a shortened URL
`list_tags`	List all tags

Development

# Clone the repository
git clone https://github.com/magnus919/mcp-shlink
cd mcp-shlink

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

# Lint and format
ruff check .
ruff format .

# Type check
mypy src/

# Full verification
ruff check . && ruff format . --check && mypy src/ && pytest

Project Structure

src/mcp_shlink/
├── server.py       # FastMCP server entry point
├── client.py       # Shlink API client
├── tools.py        # MCP tool definitions
└── models.py       # Pydantic models for API requests/responses

tests/
├── test_tools.py    # Unit tests for MCP tools
└── test_client.py   # Unit tests for Shlink client

License

Apache 2.0. See LICENSE.

from github.com/magnus919/mcp-shlink

Install Shlink in Claude Desktop, Claude Code & Cursor

Recommended · one command, every IDE

unyly install mcp-shlink

Installs into Claude Desktop, Claude Code, Cursor & VS Code — handles npx, uvx and build-from-source repos for you.

First time? Get the CLI: curl -fsSL https://unyly.org/install | sh

Or configure manually

Run in your terminal:

claude mcp add mcp-shlink -- uvx mcp-shlink

FAQ

Is Shlink MCP free?

Yes, Shlink MCP is free — one-click install via Unyly at no cost.

Does Shlink need an API key?

No, Shlink runs without API keys or environment variables.

Is Shlink hosted or self-hosted?

A hosted option is available: Unyly runs the server in the cloud, no local setup required.

How do I install Shlink in Claude Desktop, Claude Code or Cursor?

Open Shlink on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.

Related MCPs

Fetch

Web content fetching and conversion for efficient LLM usage.

by Community

AWS KB Retrieval

Retrieval from AWS Knowledge Base using Bedrock Agent Runtime.

by modelcontextprotocol

Spring AI MCP Server

Provides auto-configuration for setting up an MCP server in Spring Boot applications.