- Home
- MCP servers
- Linkly
Linkly
- javascript
0
GitHub Stars
javascript
Language
5 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
You can manage Linkly links, domains, and analytics through an MCP server that supports both hosted and self-hosted setups. Use the hosted server for quick starts or run your own instance for full control and offline operation. This MCP server lets you create, read, update, and delete links, view analytics, manage domains and webhooks, and export data—all from a consistent MCP client interface.
How to use
You connect an MCP client to either the hosted Linkly MCP server or a self-hosted instance. With the hosted option, you authenticate using your Linkly account and perform actions directly against the online service. With self-hosted, you run the server locally and provide your API key and workspace to authorize requests. You can perform common tasks such as creating short links, updating link details, and retrieving analytics data. You can also manage custom domains, favicons, and webhooks, then export click data for reporting.
How to install
Prerequisites: ensure you have Node.js and npm installed on your machine.
Option A — Hosted server (recommended) setup is immediate; you simply connect your MCP client to the hosted server URL and authenticate.
Option B — Self-hosted (npm) setup: install the MCP server package and run it locally.
# Install the MCP server globally
npm install -g linkly-mcp-server
Or run directly with npx
npx linkly-mcp-server
Additional setup and configuration
When running self-hosted, set your API credentials and workspace to enable requests from the MCP server.
export LINKLY_API_KEY="your-api-key"
export LINKLY_WORKSPACE_ID="your-workspace-id"
Usage with Claude Desktop
If you want to integrate with Claude Desktop, specify the MCP server and environment variables in your Claude configuration to run the server as a background process.
{
"mcpServers": {
"linkly": {
"command": "npx",
"args": ["linkly-mcp-server"],
"env": {
"LINKLY_API_KEY": "your-api-key",
"LINKLY_WORKSPACE_ID": "your-workspace-id"
}
}
}
}
Available tools
create_link
Create a new short link with a destination URL and optional metadata like notes, expiration, or domain.
update_link
Modify the properties of an existing short link, such as the destination URL, expiration, or notes.
delete_link
Remove a short link from the workspace.
get_link
Retrieve detailed information for a specific short link by its identifier.
list_links
List all short links within the current workspace, with optional filters.
search_links
Search links by name, URL, or note using query parameters.
get_analytics
Fetch time-series click data for one or more links over a selected period.
get_analytics_by
Aggregate click data grouped by a specified dimension (e.g., country, device, or referrer).
get_clicks
Retrieve recent click events for analysis or troubleshooting.
export_clicks
Export detailed click records for external reporting or data science workflows.
list_domains
List all custom domains associated with the workspace.
create_domain
Add a new custom domain to host short links.
delete_domain
Remove a custom domain from the workspace.
update_domain_favicon
Update the favicon for a custom domain.
list_webhooks
List webhooks configured at the workspace level.
subscribe_webhook
Add a new webhook to receive events from the workspace.
unsubscribe_webhook
Remove a workspace webhook.
list_link_webhooks
List webhooks configured for a specific link.
subscribe_link_webhook
Add a webhook for a specific link to receive events.
unsubscribe_link_webhook
Remove a webhook for a specific link.