README
🚀 Linkly MCP 服务器
Linkly MCP 服务器是一个基于 MCP(模型上下文协议)的服务器,它能让 Claude 和 ChatGPT 等 AI 助手创建和管理短链接、跟踪点击情况,并实现 URL 管理自动化。
✨ 主要特性
链接管理
- create_link - 可完全自定义创建新的短链接(支持 UTM 参数、像素代码、开放图等)
- update_link - 更新现有链接
- delete_link - 删除链接
- get_link - 获取特定链接的详细信息
- list_links - 列出工作区中所有链接及其点击统计信息
- search_links - 按名称、URL 或备注搜索链接
分析功能
- get_clicks - 获取近期点击数据
- get_analytics - 获取用于绘制图表的时间序列点击数据(按天/小时)
- get_analytics_by - 按维度(国家、平台、浏览器等)分组获取点击计数
- export_clicks - 导出详细的点击记录
域名管理
- list_domains - 列出工作区中所有自定义域名
- create_domain - 添加自定义域名
- delete_domain - 删除自定义域名
网络钩子管理
- list_webhooks - 列出工作区级别的网络钩子订阅
- subscribe_webhook - 订阅一个 URL 以接收所有链接的点击事件
- unsubscribe_webhook - 取消订阅一个网络钩子 URL
- list_link_webhooks - 列出特定链接的网络钩子
- subscribe_link_webhook - 订阅一个 URL 以接收特定链接的点击事件
- unsubscribe_link_webhook - 取消订阅特定链接的点击事件
📦 安装指南
cd integrations/mcp-server
npm install
📚 详细文档
配置
设置以下环境变量:
export LINKLY_API_KEY="your-api-key"
export LINKLY_WORKSPACE_ID="your-workspace-id"
你可以在 Linkly 仪表盘的 设置 → API 中找到这些信息。
与 Claude Desktop 快速开始
将以下内容添加到你的 Claude Desktop 配置文件中(在 macOS 上为 ~/Library/Application Support/Claude/claude_desktop_config.json):
{
"mcpServers": {
"linkly": {
"command": "npx",
"args": ["-y", "linkly-mcp-server"],
"env": {
"LINKLY_API_KEY": "your-api-key",
"LINKLY_WORKSPACE_ID": "your-workspace-id"
}
}
}
}
有关详细的设置说明和使用示例,请参阅 Claude Desktop 设置指南。
与 ChatGPT 快速开始
你可以通过创建带有操作的自定义 GPT,在 ChatGPT 中使用 Linkly。这允许你直接在 ChatGPT 对话中管理短链接。
有关分步说明,请参阅 ChatGPT 设置指南。
在 Claude Code 中使用
将以下内容添加到你的 Claude Code MCP 设置中:
{
"mcpServers": {
"linkly": {
"command": "npx",
"args": ["-y", "linkly-mcp-server"],
"env": {
"LINKLY_API_KEY": "your-api-key",
"LINKLY_WORKSPACE_ID": "your-workspace-id"
}
}
}
}
💻 使用示例
可用工具
create_link
创建一个新的短链接。
必需参数:
url- 目标 URL
可选参数:
name- 链接的昵称note- 私有备注domain- 自定义域名slug- 自定义后缀(必须以 / 开头)enabled- 链接是否激活(默认:true)utm_source,utm_medium,utm_campaign,utm_term,utm_content- UTM 参数og_title,og_description,og_image- 开放图元数据fb_pixel_id- Meta/Facebook 像素 IDga4_tag_id- Google Analytics 4 标签 IDgtm_id- Google 标签管理器 IDcloaking- 在 iframe 中隐藏目标 URLforward_params- 将 URL 参数转发到目标block_bots- 阻止机器人和爬虫hide_referrer- 隐藏推荐信息expiry_datetime- 链接过期时间(ISO 8601 格式)expiry_destination- 过期后的备用 URL
update_link
更新现有链接。
必需参数:
link_id- 要更新的链接 ID
create_link 中的所有其他参数均为可选参数。
delete_link
删除链接。
必需参数:
link_id- 要删除的链接 ID
get_link
获取特定链接的详细信息。
必需参数:
link_id- 要检索的链接 ID
list_links
列出工作区中的所有链接,无需参数。
get_clicks
获取近期点击数据。
可选参数:
link_id- 按链接 ID 过滤点击数据
get_analytics
获取用于绘制图表的时间序列点击分析数据。
可选参数:
start- 开始日期(YYYY-MM-DD,默认:30 天前)end- 结束日期(YYYY-MM-DD,默认:今天)link_id- 按特定链接过滤frequency- 时间粒度:day(默认)或hourcountry- 按国家代码过滤(例如,'US'、'GB')platform- 按平台过滤(桌面、移动、平板)browser- 按浏览器名称过滤unique- 仅计算唯一点击(按 IP)bots- 机器人过滤:include(默认)、exclude或only
get_analytics_by
按维度分组获取点击计数,适用于细分和前 N 报告。
必需参数:
counter- 分组维度:country、platform、browser_name、referer、isp、link_id、destination、bot_name
可选参数:
start- 开始日期(YYYY-MM-DD)end- 结束日期(YYYY-MM-DD)link_id- 按特定链接过滤country- 按国家代码过滤platform- 按平台过滤unique- 仅计算唯一点击bots- 机器人过滤
export_clicks
导出包含完整信息的详细点击记录。
可选参数:
start- 开始日期(YYYY-MM-DD,默认:30 天前)end- 结束日期(YYYY-MM-DD,默认:昨天)link_id- 按特定链接过滤country- 按国家代码过滤platform- 按平台过滤bots- 机器人过滤
返回值:包含时间戳、浏览器、国家、URL、链接 ID、平台、推荐来源、机器人、ISP 和参数的点击记录数组。
search_links
按名称、URL 或备注搜索链接。
必需参数:
query- 用于匹配链接名称、URL 和备注的搜索字符串
list_domains
列出工作区中的所有自定义域名,无需参数。
create_domain
向工作区添加自定义域名。
必需参数:
name- 域名(例如,'links.example.com')
delete_domain
从工作区中删除自定义域名。
必需参数:
domain_id- 要删除的域名 ID
list_webhooks
列出订阅到工作区的所有网络钩子 URL,无需参数。
subscribe_webhook
订阅一个网络钩子 URL 以接收所有链接的点击事件。
必需参数:
url- 用于接收点击事件通知的网络钩子 URL
unsubscribe_webhook
取消订阅工作区点击事件的网络钩子 URL。
必需参数:
url- 要取消订阅的网络钩子 URL
list_link_webhooks
列出订阅到特定链接的所有网络钩子 URL。
必需参数:
link_id- 链接 ID
subscribe_link_webhook
订阅一个网络钩子 URL 以接收特定链接的点击事件。
必需参数:
link_id- 链接 IDurl- 用于接收点击事件通知的网络钩子 URL
unsubscribe_link_webhook
取消订阅特定链接的点击事件的网络钩子 URL。
必需参数:
link_id- 链接 IDurl- 要取消订阅的网络钩子 URL
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫