YOURLS-MCP
About
Model Control Protocol (MCP) server for YOURLS URL shortening integration with Claude Desktop
Explore
- Shorten URLs using your YOURLS instance
- Create custom short URLs with specific keywords
- Duplicate URL Handling: Create multiple short URLs for the same destination URL (unique to YOURLS-MCP)
- Expanded URL information and statistics
- Database statistics
- Intelligent fallbacks for plugins
- Comprehensive documentation and testing tools
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
YOURLS-MCPCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
npm install
The following environment variables can be set in the Claude Desktop config:
| Variable | Description | Default | Required |
|----------|-------------|---------|----------|
| YOURLS_API_URL | URL to your YOURLS API endpoint | - | Yes |
| YOURLS_AUTH_METHOD | Authentication method (signature or password) | signature | No |
| YOURLS_SIGNATURE_TOKEN | Secret token for signature-based auth | - | Yes (if using signature auth) |
| YOURLS_USERNAME | Username for password-based auth | - | Yes (if using password auth) |
| YOURLS_PASSWORD | Password for password-based auth | - | Yes (if using password auth) |
| YOURLS_SIGNATURE_TTL | Time-to-live for signatures in seconds | 43200 (12 hours) | No |
Once configured, Claude will be able to use the YOURLS tools with prompts like:
{
"mcpServers": {
"yourls": {
"command": "node",
"args": [
"/full/path/to/yourls-mcp/yourls-mcp.js"
],
"env": {
"YOURLS_API_URL": "https://your-yourls-domain.com/yourls-api.php",
"YOURLS_AUTH_METHOD": "signature",
"YOURLS_SIGNATURE_TOKEN": "your-secret-signature-token"
}
}
}
}
YOURLS-MCP provides the following tools to Claude:
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"yourls-mcp": {
"yourls-mcp": {
"command": "node",
"args": [
"yourls-mcp.js"
]
}
}
}
}McpServers
{
"yourls-mcp": {
"command": "node",
"args": [
"yourls-mcp.js"
]
}
}A Model Control Protocol (MCP) server for integrating YOURLS URL shortening with Claude Desktop.
Author: Martin Kessler
Overview
YOURLS-MCP creates a bridge between Claude Desktop and your self-hosted YOURLS URL shortener instance. When configured, it allows Claude to automatically shorten URLs using your personal YOURLS installation.
Features
- Shorten URLs using your YOURLS instance
- Create custom short URLs with specific keywords
- Duplicate URL Handling: Create multiple short URLs for the same destination URL (unique to YOURLS-MCP)
- Expanded URL information and statistics
- Database statistics
- Intelligent fallbacks for plugins
- Comprehensive documentation and testing tools
Quick Start
Installation
```bash
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
