Linkly

Official25 tools

by Linkly-HQ · TypeScript

Create and manage short links, track clicks, and automate URL management

Create, manage, and track short links with URL automation.

Captured live from the server via tools/list.

test_authentication

Test API Authentication

No parameters.

list_workspaces

Return details of authenticated workspace

No parameters.

batchDeleteLinks

Batch delete multiple links

Parameters (1)

idsarrayrequired
Array of link IDs to delete

update_workspace

Update workspace settings

Parameters (2)

namestringrequired
Workspace name
webhooksstringrequired
Webhook URL for notifications

list_links

List links with sorting and search

Parameters (5)

pageinteger
page_sizeinteger
searchstring
Search Query
sort_bystring
Field to sort by
sort_dirstring
Sort direction

ping

Health check

Parameters (1)

messagestringrequired
a message to ping , default to Hello From Linkkly

create_link

Create short links and URL shorteners. Use this when the user asks to shorten a URL, create a short link, or make a link shorter.

Parameters (23)

urlstringrequired
The destination URL for the link (required)
namestring
A nickname for the link to identify it later
notestring
A private note about this link
domainstring
Custom domain for the short link (without trailing /)
slugstring
Custom slug/suffix for the link (must start with /)
enabledboolean
Whether the link is active (default: true)
utm_sourcestring
UTM source parameter
utm_mediumstring
UTM medium parameter
utm_campaignstring
UTM campaign parameter
utm_termstring
UTM term parameter
utm_contentstring
UTM content parameter
og_titlestring
Open Graph title for social media previews
og_descriptionstring
Open Graph description for social media previews
og_imagestring
Open Graph image URL for social media previews
fb_pixel_idstring
Meta/Facebook Pixel ID for tracking
ga4_tag_idstring
Google Analytics 4 tag ID
gtm_idstring
Google Tag Manager container ID
cloakingboolean
Hide destination URL by opening in an iframe
forward_paramsboolean
Forward URL parameters to the destination
block_botsboolean
Block known bots and spiders from following the link
hide_referrerboolean
Hide referrer information when users click
expiry_datetimestring
ISO 8601 datetime when the link should expire
expiry_destinationstring
Fallback URL after expiry (404 if blank)

update_link

Update an existing Linkly link by its ID

Parameters (22)

link_idintegerrequired
The ID of the link to update (required)
urlstring
New destination URL
namestring
New nickname for the link
notestring
New private note
enabledboolean
Whether the link is active
utm_sourcestring
UTM source parameter
utm_mediumstring
UTM medium parameter
utm_campaignstring
UTM campaign parameter
utm_termstring
UTM term parameter
utm_contentstring
UTM content parameter
og_titlestring
Open Graph title
og_descriptionstring
Open Graph description
og_imagestring
Open Graph image URL
fb_pixel_idstring
Meta Pixel ID
ga4_tag_idstring
Google Analytics 4 tag ID
gtm_idstring
Google Tag Manager ID
cloakingboolean
Enable URL cloaking
forward_paramsboolean
Forward URL parameters
block_botsboolean
Block bots
hide_referrerboolean
Hide referrer
expiry_datetimestring
Expiry datetime (ISO 8601)
expiry_destinationstring
Fallback URL after expiry

delete_link

Delete a Linkly link by its ID

Parameters (1)

link_idintegerrequired
The ID of the link to delete

get_link

Get details of a specific Linkly link by its ID

Parameters (1)

link_idintegerrequired
The ID of the link to retrieve

get_clicks

Get recent click data for the workspace

Parameters (1)

link_idinteger
Optional: filter clicks by link ID

get_analytics

Get time-series click analytics data for charting. Returns click counts over time.

Parameters (9)

startstring
Start date in YYYY-MM-DD format (default: 30 days ago)
endstring
End date in YYYY-MM-DD format (default: today)
link_idinteger
Filter by specific link ID
frequencystring
Time granularity: 'day' (default) or 'hour'
countrystring
Filter by country code (e.g., 'US', 'GB')
platformstring
Filter by platform (e.g., 'desktop', 'mobile', 'tablet')
browserstring
Filter by browser name
uniqueboolean
Count unique clicks only (by IP)
botsstring
Bot filtering: include (default), exclude, or only

get_analytics_by

Get click counts grouped by a dimension (country, platform, browser, etc.). Useful for breakdowns and top-N reports.

Parameters (8)

counterstringrequired
Dimension to group by (required)
startstring
Start date in YYYY-MM-DD format (default: 30 days ago)
endstring
End date in YYYY-MM-DD format (default: today)
link_idinteger
Filter by specific link ID
countrystring
Filter by country code
platformstring
Filter by platform
uniqueboolean
Count unique clicks only
botsstring
Bot filtering

export_clicks

Export detailed click records with full information (timestamp, browser, country, URL, platform, referer, bot, ISP, params).

Parameters (6)

startstring
Start date in YYYY-MM-DD format (default: 30 days ago)
endstring
End date in YYYY-MM-DD format (default: yesterday)
link_idinteger
Filter by specific link ID
countrystring
Filter by country code
platformstring
Filter by platform
botsstring
Bot filtering

list_domains

List all custom domains in the workspace.

No parameters.

create_domain

Add a custom domain to the workspace. The domain must be configured to point to Linkly's servers.

Parameters (1)

namestringrequired
The domain name (e.g., 'links.example.com')

delete_domain

Remove a custom domain from the workspace.

Parameters (1)

domain_idintegerrequired
The ID of the domain to delete

update_domain_favicon

Update the favicon URL for a custom domain.

Parameters (2)

domain_idintegerrequired
The ID of the domain to update
favicon_urlstringrequired
URL to the favicon image

search_links

Search for links by name, URL, or note. Returns matching links with click statistics.

Parameters (1)

querystringrequired
Search query to match against link names, URLs, and notes

list_webhooks

List all webhook URLs subscribed to the workspace. These receive click events for all links.

No parameters.

subscribe_webhook

Subscribe a webhook URL to receive click events for all links in the workspace.

Parameters (1)

urlstringrequired
The webhook URL to receive click event notifications

unsubscribe_webhook

Unsubscribe a webhook URL from workspace click events.

Parameters (1)

urlstringrequired
The webhook URL to unsubscribe

list_link_webhooks

List all webhook URLs subscribed to a specific link.

Parameters (1)

link_idintegerrequired
The ID of the link

subscribe_link_webhook

Subscribe a webhook URL to receive click events for a specific link.

Parameters (2)

link_idintegerrequired
The ID of the link
urlstringrequired
The webhook URL to receive click event notifications

unsubscribe_link_webhook

Unsubscribe a webhook URL from a specific link's click events.

Parameters (2)

link_idintegerrequired
The ID of the link
urlstringrequired
The webhook URL to unsubscribe

README.md6 KBView on GitHub

Linkly MCP Server

Official Model Context Protocol (MCP) server for Linkly — the URL shortener and link management platform.

This repository powers the hosted MCP server at https://mcp.linklyhq.com. That is the only supported way to connect an AI assistant to Linkly via MCP. See https://linklyhq.com/support/mcp-server for setup instructions.

⚠️ The linkly-mcp-server npm package is deprecated. The self-hosted / API-key flow is no longer maintained. All users should migrate to the hosted server — it uses OAuth 2.1 with PKCE, requires no API keys or local install, and always runs the latest tool set. The npm package will continue to exist on the registry for backwards compatibility but will not receive new tools or bug fixes, and may be unpublished in the future.

Documentation

For full documentation, setup guides, and examples, visit: https://linklyhq.com/support/mcp-server

Features

Create, update, and delete short links
View click analytics and statistics
Manage custom domains and favicons
Configure webhooks for click events
Search and filter links
Export click data

Using the hosted server

Server URL: https://mcp.linklyhq.com

Connect your MCP client to the hosted server and sign in to Linkly when your browser opens. That's it — no API keys, no installation, no config drift.

Claude Desktop

json

{
  "mcpServers": {
    "linkly": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.linklyhq.com"]
    }
  }
}

Claude Code (CLI)

bash

claude mcp add --transport http linkly https://mcp.linklyhq.com

ChatGPT Desktop

json

{
  "servers": {
    "linkly": {
      "type": "url",
      "url": "https://mcp.linklyhq.com"
    }
  }
}

Available Tools

Tool	Description
`create_link`	Create a new short link
`update_link`	Update an existing link
`delete_link`	Delete a link
`get_link`	Get link details
`list_links`	List all links in workspace
`search_links`	Search links by name, URL, or note
`get_analytics`	Get time-series click data
`get_analytics_by`	Get clicks grouped by dimension
`get_clicks`	Get recent click data
`export_clicks`	Export detailed click records
`list_domains`	List custom domains
`create_domain`	Add a custom domain
`delete_domain`	Remove a custom domain
`update_domain_favicon`	Update domain favicon
`list_webhooks`	List workspace webhooks
`subscribe_webhook`	Add a webhook
`unsubscribe_webhook`	Remove a webhook
`list_link_webhooks`	List link-specific webhooks
`subscribe_link_webhook`	Add a link webhook
`unsubscribe_link_webhook`	Remove a link webhook

Support

For help and support, visit Linkly Support or email support@linklyhq.com.

Publishing to the MCP Registry (maintainers)

The server.json at the repo root is the official MCP Registry manifest for the com.linklyhq/linkly server. It is remote-only: it points clients at the hosted server and intentionally ships no package (the deprecated npm distribution was dropped in v2.0.0).

Publishing requires DNS access to linklyhq.com — the com.linklyhq namespace is verified via a DNS TXT record on the domain apex:

bash

# 1. Generate an Ed25519 key + TXT record (macOS: use openssl@3; system LibreSSL lacks Ed25519)
openssl genpkey -algorithm Ed25519 -out key.pem
PUBLIC_KEY="$(openssl pkey -in key.pem -pubout -outform DER | tail -c 32 | base64)"
echo "linklyhq.com. IN TXT \"v=MCPv1; k=ed25519; p=${PUBLIC_KEY}\""   # add at the APEX of linklyhq.com

# 2. Authenticate the namespace + publish
PRIVATE_KEY="$(openssl pkey -in key.pem -noout -text | grep -A3 'priv:' | tail -n +2 | tr -d ' :\n')"
mcp-publisher login dns --domain linklyhq.com --private-key "$PRIVATE_KEY"
mcp-publisher publish

See the registry authentication guide for details.

Updating the ChatGPT app (maintainers)

chatgpt-app-submission.json is the OpenAI Apps SDK submission import — it pre-fills the per-tool annotations and the three safety justifications (read-only / open-world / destructive) for all 25 tools, so they don't have to be typed by hand in the dashboard.

OpenAI freezes a metadata snapshot at publish time and does not auto-detect MCP changes, so after deploying server changes you publish a new version:

Deploy the worker (push to the connected branch / wrangler deploy).
Platform dashboard → the Linkly app → create a new draft version (keep the same MCP URL https://mcp.linklyhq.com).
In the MCP section, click Scan Tools to re-read the live tool list + annotations.
Drag chatgpt-app-submission.json onto the form (top of the page) to fill the justifications.
Review Testing, then Submit. The published version keeps running against the live server until the new one is approved.

Keep this file in sync with the worker whenever tools are added/removed or their readOnlyHint/destructiveHint change. The destructive flag is true only for the 5 genuinely destructive tools (delete_link, delete_domain, batchDeleteLinks, unsubscribe_webhook, unsubscribe_link_webhook); creates/updates/subscribes are additive (false).

License

MIT

Install

Tools (25)

test_authenticationlist_workspacesbatchDeleteLinksupdate_workspacelist_linkspingcreate_linkupdate_link

Remote endpoint

Streamable HTTP

Hosted server - connect over the network, no local install.

url

https://mcp.linklyhq.com

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "linkly": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.linklyhq.com"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.